パッケージ jakarta.xml.bind.annotation
Java プログラム要素を XML スキーママッピングにカスタマイズするためのアノテーションを定義します。
このドキュメントでの JAXB への参照は、特に明記されていない限り、Jakarta XML Binding を指します。
パッケージ仕様
次の表は、各プログラム要素に関連付けることができる Jakarta XML Binding マッピングアノテーションを示しています。
プログラム要素 | Jakarta XML Binding アノテーション |
---|---|
パッケージ | |
クラス | |
列挙型 | |
JavaBean プロパティ / フィールド | |
パラメーター |
用語
JavaBean プロパティとフィールド : マッピングの目的上、フィールドと JavaBean プロパティの間に意味上の違いはありません。JavaBean プロパティに適用できるアノテーションは、常にフィールドに適用できます。Javadoc のドキュメントでは、簡潔にするために、JavaBean プロパティまたはプロパティという用語は、JavaBean プロパティまたはフィールドのいずれかを意味するために使用されます。必要に応じて、両方が明示的に記載されています。
トップレベルクラス : マッピングの目的で、トップレベルクラスと静的ネストクラスの間に意味上の違いはありません。最上位クラスに適用できるアノテーションは、ネストされた静的クラスにいつでも適用できます。Javadoc のドキュメントでは、簡潔にするために、「トップレベルクラス」または単にクラスという用語は、トップレベルクラスまたはネストされた静的クラスのいずれかを意味するために使用されます。
マッピングアノテーション :JSR175 プログラミングアノテーション機能に基づく Jakarta XML Binding 定義のプログラムアノテーション。
一般的な使用上の制約
以下の使用上の制約は、アノテーション以外にも適用されるため、ここで定義されています。
- プロパティの場合、特定のアノテーションを読み取りプロパティまたは書き込みプロパティのいずれかに適用できますが、両方に適用することはできません。
- プロパティ名は、マップされているクラスのスーパークラスのいずれかの他のプロパティ名とは異なっている必要があります。
- マップされたフィールド名またはマップされたプロパティの大文字と小文字を区別しない名前は、クラス内で一意である必要があります。
表記
名前空間接頭部このパッケージの XML スキーマフラグメントでは、次の名前空間プレフィックスが使用されています。
接頭辞 | 名前空間 | ノート |
---|---|---|
xs | http://www.w3.org/2001/XMLSchema | XML スキーマ名前空間の名前空間 |
参照 | http://ws-i.org/profiles/basic/1.1/xsd | swaref スキーマコンポーネントの名前空間 |
xsi | http://www.w3.org/2001/XMLSchema-instance | インスタンスの XML スキーマ名前空間 |
- 導入:
- 1.6、JAXB 2.0
インターフェースのサマリー インターフェース 説明 DomHandler<ElementT,ResultT extends ResultSE> 要素(およびその子孫)を DOM(または同様の)表現との間で変換します。クラスのサマリー クラス 説明 W3CDomHandler W3CDOM のDomHandler
実装 (org.w3c.dom
パッケージ。)XmlElement.DEFAULT XmlElement.type()
で使用され、プロパティの署名から型が推測されることを通知します。XmlElementDecl.GLOBAL XmlElementDecl.scope()
で使用され、宣言がグローバルスコープ内にあることを通知します。XmlElementRef.DEFAULT XmlElementRef.type()
で使用され、プロパティの署名から型が推測されることを通知します。XmlSchemaType.DEFAULT XmlSchemaType.type()
で使用され、プロパティの署名から型が推測されることを通知します。XmlType.DEFAULT XmlType.factoryClass()
で使用され、ファクトリメホッドが使用されていないか、このXmlType
自体のクラスにあることを通知します。列挙型のサマリー 列挙型 説明 XmlAccessOrder XmlAccessorOrder によって使用され、Jakarta XML Binding バインドクラスのプロパティとフィールドの順序を制御します。XmlAccessType フィールドまたはプロパティの直列化を制御するために XmlAccessorType によって使用されます。XmlNsForm XML スキーマ名前空間修飾の列挙。アノテーション型のサマリー アノテーション型 説明 XmlAccessorOrder クラス内のフィールドとプロパティの順序を制御します。XmlAccessorType フィールドまたは Javabean プロパティをデフォルトで直列化するかどうかを制御します。XmlAnyAttribute JavaBean プロパティをワイルドカード属性のマップにマップします。XmlAnyElement JavaBean プロパティを XML 情報セット表現や JAXBElement にマップします。XmlAttachmentRef XML 形式が mime コンテンツへの URI 参照であることをフィールド / プロパティにマークします。XmlAttribute JavaBean プロパティを XML 属性にマップします。XmlElement JavaBean プロパティをプロパティ名から派生した XML 要素にマップします。XmlElementDecl ファクトリメソッドを XML 要素にマップします。XmlElementRef JavaBean プロパティをプロパティの型から派生した XML 要素にマップします。XmlElementRefs XmlElement
または JAXBElement でクラスを参照するプロパティをマークします。XmlElements 複数の @XmlElement
アノテーションのコンテナー。XmlElementWrapper XML 表現のラッパー要素を生成します。XmlEnum 列挙型Enum
SE を XML 表現にマップします。XmlEnumValue Enum
SE 型の列挙型定数を XML 表現にマップします。XmlID JavaBean プロパティを XMLID にマップします。XmlIDREF JavaBean プロパティを XMLIDREF にマップします。XmlInlineBinaryData XML で base64 でエンコードされたバイナリデータにバインドされているデータ型の XOP エンコードの考慮を無効にします。XmlList プロパティをリスト単純型にマップするために使用されます。XmlMimeType プロパティの XML 表現を制御する MIME 型を関連付けます。XmlMixed 混合コンテンツをサポートするために、JavaBean 複数値プロパティにアノテーションを付けます。XmlNs 名前空間プレフィックスを XML 名前空間 URI に関連付けます。XmlRegistry XmlElementDecl
を持つクラスをマークします。XmlRootElement クラスまたは列挙型を XML 要素にマップします。XmlSchema パッケージ名を XML 名前空間にマップします。XmlSchemaType Java 型を単純なスキーマ組み込み型にマップします。XmlSchemaTypes 複数の @XmlSchemaType
アノテーションのコンテナー。XmlSeeAlso このクラスをバインドするときに他のクラスもバインドするように Jakarta XML Binding に指示します。XmlTransient JavaBean プロパティ / 型の XML 表現へのマッピングを防止します。XmlType クラスまたは列挙型を XML スキーマ型にマップします。XmlValue simpleContent を持つ XML スキーマ複合型または XML スキーマ単純型へのクラスのマッピングを有効にします。