javax.xml.bind.annotation
註釋型別 XmlElement

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

將 JavaBean 屬性映射到派生於屬性名稱的 XML 元素。

用法

@XmlElement 註釋可以與以下程序元素一起使用：

• JavaBean 屬性
• 非 static、非 transient 欄位
• XmlElements 中的程序元素

用法受到以下約束的限制：

• 此註釋可與以下註釋一起使用：XmlID、XmlIDREF、XmlList、XmlSchemaType、XmlValue、XmlAttachmentRef、XmlMimeType、XmlInlineBinaryData、XmlElementWrapper 和 XmlJavaTypeAdapter。
• 如果 JavaBean 屬性的型別是陣列的集合型別、索引 (indexed) 屬性或參數化列表，並且此註釋與 XmlElements 一起使用，那麼 @XmlElement.type() 在集合條目型別已知的情況下必須是 DEFAULT.class。

在使用 @XmlElement 註釋進行註釋時，JavaBean 屬性被映射到 XML 網要複雜型別中的本地元素，包含的類別被映射到此 XML 網要複雜型別。

範例 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。

從以下版本開始：

JAXB 2.0

可選元素摘要

String	defaultValue 此元素的預設值。
String	name XML 網要元素的名稱。
String	namespace XML 網要元素的 XML 目標名稱空間。
boolean	nillable 將元素宣告自定義為 nillable。
boolean	required 自定義所需的元素宣告。
Class	type 正被參考的 Java 類別。

name

public abstract String name

XML 網要元素的名稱。

如果值為 "##default"，那麼元素名稱派生於 JavaBean 屬性名稱。

預設值：

"##default"

nillable

public abstract boolean nillable

將元素宣告自定義為 nillable。

如果 nillable() 為 true，那麼 JavaBean 屬性被映射到 XML 網要 nillable 元素宣告。

預設值：

false

required

public abstract boolean required

自定義所需的元素宣告。

如果 required() 為 true，則將 Javabean 屬性映射到一個 minOccurs="1" 的 XML 網要元素宣告。maxOccurs 為 "1" 表示單個賦值的屬性，maxOccurs 為 "unbounded" 則表示多個賦值的屬性。

如果 required() 為 false，則將 Javabean 屬性映射到一個 minOccurs="0" 的 XML 網要元素宣告。maxOccurs 為 "1" 表示單個賦值的屬性，maxOccurs 為 "unbounded" 則表示多個賦值的屬性。

預設值：

false

namespace

public abstract String namespace

XML 網要元素的 XML 目標名稱空間。

如果該值為 "##default"，則名稱空間通過以下方式確定：

1. 如果封閉包中包含 XmlSchema 註釋，並且其 elementFormDefault 為 QUALIFIED，則名稱空間為封閉類別的名稱空間。
2. 否則名稱空間為 ""（這將導致在預設名稱空間中產生非限定元素）。

預設值：

"##default"

defaultValue

public abstract String defaultValue

此元素的預設值。

作為此註釋元素的預設值指定的 '' 值被用作 null 的替代，從而允許識別 'no default value' 狀態。

預設值：

"\u0000"

type

public abstract Class type

正被參考的 Java 類別。

預設值：

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