パッケージ javax.xml.bind.annotation
Javaプログラム要素からXML Schemaへのマッピングをカスタマイズするための注釈を定義します。
パッケージの仕様
次の表は、各プログラム要素に関連付けられるJAXBマッピング注釈を示します。
| プログラム要素 | JAXB注釈 |
|---|---|
| パッケージ | |
| クラス | |
| 列挙型 | |
| JavaBeanプロパティ/フィールド | |
| Parameter |
用語
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名前空間 |
- 導入されたバージョン:
- 1.6, JAXB 2.0
-
インタフェースのサマリー インタフェース 説明 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単純型へのクラスのマッピングを可能にします。