javax.xml.bind.annotation

注釈型 XmlElement

@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD,PARAMETER})
public @interface XmlElement

JavaBean プロパティーを、プロパティー名から派生した XML 要素にマップします。

使用法

@XmlElement 注釈は、次のプログラム要素で使用できます。

• JavaBean プロパティー
• static でない非一時フィールド
• XmlElements 内

使用には次の制約があります。

• この注釈は、次の注釈とともに使用できます。XmlID, XmlIDREF, XmlList, XmlSchemaType, XmlValue, XmlAttachmentRef, XmlMimeType, XmlInlineBinaryData, XmlElementWrapper, XmlJavaTypeAdapter
• JavaBean プロパティーの型が配列コレクション型、インデックス付きプロパティー、またはパラメータ化リストであり、この注釈が XmlElements とともに使用された場合、コレクション項目型が既知であるため、@XmlElement.type() が DEFAULT.class である必要があります。

@XmlElement で注釈された JavaBean プロパティーは、それを含むクラスがマップされる XML Schema 複合型のローカル要素にマップされます。

例 1:public の非 static 非 final フィールドをローカル要素にマップします。

     //Example: Code fragment
     public class USPrice {
         @XmlElement(name="itemprice")
         public java.math.BigDecimal price;
     }

     <!-- Example: Local XML Schema element -->
     <xs:complexType name="USPrice"/>
       <xs:sequence>
         <xs:element name="itemprice" type="xs:decimal" minOccurs="0"/>
       </sequence>
     </xs:complexType>
   

例 2:フィールドを nillable 要素にマップします。

     //Example: Code fragment
     public class USPrice {
         @XmlElement(nillable=true)
         public java.math.BigDecimal price;
     }

     <!-- Example: Local XML Schema element -->
     <xs:complexType name="USPrice">
       <xs:sequence>
         <xs:element name="price" type="xs:decimal" nillable="true" minOccurs="0"/>
       </sequence>
     </xs:complexType>
   

例 3:フィールドを nillable、required 要素にマップします。

     //Example: Code fragment
     public class USPrice {
         @XmlElement(nillable=true, required=true)
         public java.math.BigDecimal price;
     }

     <!-- Example: Local XML Schema element -->
     <xs:complexType name="USPrice">
       <xs:sequence>
         <xs:element name="price" type="xs:decimal" nillable="true" minOccurs="1"/>
       </sequence>
     </xs:complexType>
   

例 4:匿名型を使用して、JavaBean プロパティーを XML 要素にマップします。

@XmlType の例 6 を参照してください。

導入されたバージョン:

JAXB2.0

オプション要素のサマリー

省略可能な要素

修飾子と型	省略可能な要素と説明
String	defaultValue この要素のデフォルト値です。
String	name XML スキーマ要素の名前です。
String	namespace XML Schema 要素の XML ターゲット名前空間です。
boolean	nillable 要素宣言をカスタマイズして nillable にします。
boolean	required 要素宣言をカスタマイズして required にします。
Class	type 参照される Java クラスです。

要素の詳細

name

public abstract String name

XML スキーマ要素の名前です。

値が「##default」の場合、要素名は JavaBean プロパティー名から派生します。

デフォルトは、

「##default」

nillable

public abstract boolean nillable

要素宣言をカスタマイズして nillable にします。

nillable() が true の場合、JavaBean プロパティーは XML Schema nillable 要素宣言にマップされます。

デフォルトは、

false

required

public abstract boolean required

要素宣言をカスタマイズして required にします。

required() が true の場合、JavaBean プロパティーは、「minOccurs="1"」のXML Schema 要素宣言にマップされます。maxOccurs は、単一値のプロパティーの場合は「1」、複数値のプロパティーの場合は「unbounded」です。

required() が false の場合、JavaBean プロパティーは、「minOccurs="0"」の XML Schema 要素宣言にマップされます。maxOccurs は、単一値のプロパティーの場合は「1」、複数値のプロパティーの場合は「unbounded」です。

デフォルトは、

false

namespace

public abstract String namespace

XML Schema 要素の XML ターゲット名前空間です。

値が「##default」の場合、名前空間は次のように決定されます。

1. それを含むパッケージに XmlSchema 注釈型があり、それの elementFormDefault が QUALIFIED の場合、それを含むクラスの名前空間。
2. それ以外の場合、「」(これは、デフォルト名前空間に非修飾要素を生成します)。

デフォルトは、

「##default」

defaultValue

public abstract String defaultValue

この要素のデフォルト値です。

この注釈要素のデフォルトとして指定されている

''

値は、null の代わりに使用して実装が非デフォルト値の状態を認識できるようにする経済的な代替品です。

デフォルトは、

「\u0000」

type

public abstract Class type

参照される Java クラスです。

デフォルトは、

javax.xml.bind.annotation.XmlElement.DEFAULT.class