モジュール java.xml.bind

パッケージ javax.xml.bind.annotation

注釈型XmlRootElement

@Retention(RUNTIME)
@Target(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>
 

導入されたバージョン:

1.6, JAXB 2.0

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

オプションの要素

修飾子と型	オプション要素	説明
String	name	XML要素のローカル名です。
String	namespace	XML要素の名前空間名です。

要素の詳細

namespace

String namespace

XML要素の名前空間名です。

値が「##default」の場合、XML名前空間名はクラスのパッケージから派生します(XmlSchema)。 パッケージに名前が指定されていない場合、XML名前空間はデフォルトの空の名前空間です。

デフォルト:

「##default」

name

String name

XML要素のローカル名です。

値が「##default」の場合、名前はクラス名から派生します。

デフォルト:

「##default」