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

@Retention(value=RUNTIME)
@Target(value=TYPE)
public @interface XmlRootElement

將類別或列舉型別映射到 XML 元素。

用法

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

• 頂層類別
• 列舉型別

有關其他公共資訊，請參閱 javax.xml.bind.package javadoc 中的“套件規範”。

當使用 @XmlRootElement 註釋對頂層類別或列舉型別進行註釋時，型別值被表示為 XML 文檔中的 XML 元素。

此註釋可與以下註釋一起使用： XmlType、XmlEnum、XmlAccessorType、 XmlAccessorOrder。

範例 1：將元素與 XML 網要型別關聯

     // Example: Code fragment
     @XmlRootElement
     class Point {
        int x;
        int y;
        Point(int _x,int _y) {x=_x;y=_y;}
     }
 

     //Example: Code fragment corresponding to XML output
     marshal( new Point(3,5), System.out);
 

     <!-- Example: XML output -->
     <point>
       <x> 3 </x>
       <y> 5 </y>
     </point>
 

該註釋會導致在網要中產生全體元素宣告。全體元素宣告與類別映射到的 XML 網要型別關聯。

<!-- Example:XML schema definition -->
     <xs:element name="point" type="point"/>
     <xs:complexType name="point">
       <xs:sequence>
         <xs:element name="x" type="xs:int"/>
         <xs:element name="y" type="xs:int"/>
       </xs:sequence>
     </xs:complexType>
 

範例 2：型別繼承的正交性

某一型別上註釋的元素宣告不會被其派生型別繼承。以下範例顯示了這一點：

     // Example: Code fragment
     @XmlRootElement
     class Point3D extends Point {
         int z;
         Point3D(int _x,int _y,int _z) {super(_x,_y);z=_z;}
     }

     //Example: Code fragment corresponding to XML output * 
     marshal( new Point3D(3,5,0), System.out );

     <!-- Example: XML output -->
     <!-- The element name is point3D not point -->
     <point3D>
       <x>3</x>
       <y>5</y>
       <z>0</z>
     </point3D>

     <!-- Example: XML schema definition -->
     <xs:element name="point3D" type="point3D"/>
     <xs:complexType name="point3D">
       <xs:complexContent>
         <xs:extension base="point">
           <xs:sequence>
             <xs:element name="z" type="xs:int"/>
           </xs:sequence>
         </xs:extension>
       </xs:complexContent>
     </xs:complexType>
 

範例 3：將全體元素與該類別映射到的 XML 網要型別關聯。

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

     <!-- Example: XML schema definition -->
     <xs:element name="PriceElement" type="USPrice"/>
     <xs:complexType name="USPrice">
       <xs:sequence>
         <xs:element name="price" type="xs:decimal"/>
       </sequence>
     </xs:complexType>
 

從以下版本開始：

JAXB2.0

可選元素摘要

String	name XML 元素的本地名稱。
String	namespace XML 元素的名稱空間名。

namespace

public abstract String namespace

XML 元素的名稱空間名。

如果該值為 "##default"，那麼 XML 名稱空間名派生於類別 (XmlSchema) 的套件。如果沒有對包命名，那麼 XML 名稱空間是預設的空名稱空間。

預設值：

"##default"

name

public abstract String name

XML 元素的本地名稱。

如果值為 "##default"，則名稱派生於類別名稱。

預設值：

"##default"