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