パッケージ javax.xml.bind.annotation

Java プログラム要素から XML Schema へのマッピングをカスタマイズするための注釈を定義します。

参照: 説明

インタフェースのサマリー

インタフェース	説明
DomHandler<ElementT,ResultT extends Result>	要素 (とその子孫) を DOM (または類似) 表現に、またはその逆方向に変換します。

クラスのサマリー

クラス	説明
W3CDomHandler	W3C DOM (org.w3c.dom パッケージ) 用の DomHandler 実装。
XmlElement.DEFAULT	型がプロパティーのシグニチャーから推定されることを通知するために XmlElement.type() で使用されます。
XmlElementDecl.GLOBAL	宣言がグローバルスコープにあることを通知するために XmlElementDecl.scope() で使用されます。
XmlElementRef.DEFAULT	型がプロパティーのシグニチャーから推定されることを通知するために XmlElementRef.type() で使用されます。
XmlSchemaType.DEFAULT	型がプロパティーのシグニチャーから推定されることを通知するために XmlSchemaType.type() で使用されます。
XmlType.DEFAULT	ファクトリメソッドが使用されていないか、またはそれがこの XmlType 自身を含むクラス内にあることを通知するために XmlType.factoryClass() で使用されます。

列挙型のサマリー

列挙型	説明
XmlAccessOrder	バインドされた JAXB クラスのプロパティーとフィールドの順序を制御するために XmlAccessorOrder によって使用されます。
XmlAccessType	フィールドまたはプロパティーの直列化を制御するために XmlAccessorType によって使用されます。
XmlNsForm	XML スキーマの名前空間修飾の列挙です。

注釈型のサマリー

注釈型	説明
XmlAccessorOrder	クラス内のフィールドとプロパティーの順序を制御します。
XmlAccessorType	フィールドまたは JavaBean プロパティーがデフォルトで直列化されるかどうかを制御します。
XmlAnyAttribute	JavaBean プロパティーをワイルドカード属性マップにマップします。
XmlAnyElement	JavaBean プロパティーを、XML 情報セット表現または JAXB 要素、あるいはその両方にマップします。
XmlAttachmentRef	XML 形式が MIME コンテンツへの URI 参照であるフィールド/プロパティーをマークします。
XmlAttribute	JavaBean プロパティーを XML 属性にマップします。
XmlElement	JavaBean プロパティーを、プロパティー名から派生した XML 要素にマップします。
XmlElementDecl	ファクトリメソッドを XML 要素にマップします。
XmlElementRef	JavaBean プロパティーを、プロパティーの型から派生した XML 要素にマップします。
XmlElementRefs	XmlElement または JAXBElement を含むクラスを参照するプロパティーをマークします。
XmlElements	複数の @XmlElement 注釈のコンテナです。
XmlElementWrapper	XML 表現にかかわるラッパー要素を生成します。
XmlEnum	列挙型 Enum を XML 表現にマップします。
XmlEnumValue	Enum 型に含まれる列挙定数を XML 表現にマップします。
XmlID	JavaBean プロパティーを XML ID にマップします。
XmlIDREF	JavaBean プロパティーを XML IDREF にマップします。
XmlInlineBinaryData	XML 内の base64 エンコードバイナリデータにバインドされるデータ型に対する XOP エンコーディングの考慮を無効にします。
XmlList	プロパティーをリスト単純型にマップするために使用されます。
XmlMimeType	プロパティーの XML 表現を制御する MIME 型を関連付けます。
XmlMixed	混合コンテンツをサポートする複数値の JavaBean プロパティーを注釈します。
XmlNs	名前空間接頭辞に XML 名前空間 URI を関連付けます。
XmlRegistry	XmlElementDecl を含むクラスをマークします。
XmlRootElement	クラスまたは列挙型を XML 要素にマップします。
XmlSchema	パッケージ名を XML 名前空間にマップします。
XmlSchemaType	Java 型を単純スキーマ組み込み型にマップします。
XmlSchemaTypes	複数の @XmlSchemaType 注釈のコンテナです。
XmlSeeAlso	このクラスをバインドするときにほかのクラスもバインドするように JAXB に指示します。
XmlTransient	JavaBean プロパティー/型の XML 表現へのマッピングを禁止します。
XmlType	クラスまたは列挙型を XML Schema 型にマップします。
XmlValue	simpleContent を含む XML Schema 複合型、または XML Schema 単純型へのクラスのマッピングを可能にします。

パッケージ javax.xml.bind.annotation の説明

Java プログラム要素から XML Schema へのマッピングをカスタマイズするための注釈を定義します。

パッケージの仕様

次の表は、各プログラム要素に関連付けられる JAXB マッピング注釈を示します。

プログラム要素	JAXB 注釈
パッケージ	XmlAccessorOrder XmlAccessorType XmlSchema XmlSchemaType XmlSchemaTypes XmlJavaTypeAdapter XmlJavaTypeAdapters
クラス	XmlAccessorOrder XmlAccessorType XmlInlineBinaryData XmlRootElement XmlType XmlJavaTypeAdapter
enum 型	XmlEnum XmlEnumValue (enum 定数のみ) XmlRootElement XmlType XmlJavaTypeAdapter
JavaBean プロパティー/フィールド	XmlElement XmlElements XmlElementRef XmlElementRefs XmlElementWrapper XmlAnyElement XmlAttribute XmlAnyAttribute XmlTransient XmlValue XmlID XmlIDREF XmlList XmlMixed XmlMimeType XmlAttachmentRef XmlInlineBinaryData XmlElementDecl (メソッドでのみ) XmlJavaTypeAdapter
パラメータ	XmlList XmlAttachmentRef XmlMimeType XmlJavaTypeAdapter

用語

JavaBean プロパティーおよびフィールド: マッピングを目的とする場合、フィールドと JavaBean プロパティーの間に意味上の違いはありません。そのため、JavaBean プロパティーに適用できる注釈は常に、フィールドにも適用できます。したがって、Javadoc 文書では、簡潔さのため、JavaBean プロパティーまたはプロパティーという用語を使用するとき、JavaBean プロパティーかフィールドのいずれも意味します。必要な箇所では、この 2 つを明示的に区別します。

トップレベルクラス: マッピングを目的とする場合、トップレベルクラスと static 入れ子クラスの間に意味上の違いはありません。そのため、トップレベルクラスに適用できる注釈は常に、入れ子の static クラスにも適用できます。したがって、Javadoc 文書では、簡潔さのため、「トップレベルクラス」または単に「クラス」という用語を使用するときはトップレベルクラスか入れ子 static クラスのいずれかを意味します。

マッピング注釈: JSR 175 プログラミング注釈機能を基にした定義済みの JAXB 2.0 プログラム注釈。

一般的な使用上の制約

次に定義する使用上の制約は、注釈に限らず適用されます。

• プロパティーの場合、特定の注釈を適用できるのはプロパティーの読み取りか書き込みのいずれかであり、その両方には適用できません。
• プロパティー名は、マップされるクラスのすべてのスーパークラスのほかのどのプロパティー名とも異なる必要があります。
• マップされるフィールド名、またはマップされるプロパティーの小文字変換名は、クラス内で一意である必要があります。

表記法

名前空間接頭辞

このパッケージ内の XML スキーマフラグメントでは、次の名前空間接頭辞が使用されます。

接頭辞	名前空間	注記
xs	http://www.w3.org/2001/XMLSchema	XML Schema 名前空間の名前空間
ref	http://ws-i.org/profiles/basic/1.1/xsd	swaref スキーマコンポーネントの名前空間
xsi	http://www.w3.org/2001/XMLSchema-instance	インスタンスの XML Schema 名前空間

導入されたバージョン:

JAXB 2.0