モジュール java.xml.bind

パッケージ 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名前空間
導入されたバージョン:
1.6, JAXB 2.0