モジュール java.xml.bind
パッケージ javax.xml.bind.annotation

注釈型XmlEnumValue



  • @Retention(RUNTIME)
    @Target(FIELD)
    public @interface XmlEnumValue
    Enum型に含まれる列挙定数をXML表現にマップします。

    使用法

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

    • enum定数

    追加の一般的な情報については、javax.xml.bind.package javadocの「パッケージの仕様」を参照してください。

    この注釈型をXmlEnumとともに使用することにより、列挙型をXML表現にマッピングできます。

    列挙型は、列挙ファセットを持つスキーマ単純型にマップされます。 スキーマ型は、@XmlEnum.value()で指定されたJava型から派生します。 各enum定数@XmlEnumValueには、@XmlEnum.value()型に対する有効な字句表現が必要になります。

    この注釈がない場合、Enum.name()はXML表現として使用されます。

    例1: enum定数名 ->列挙ファセットへのマップ

         //Example: Code fragment
         @XmlEnum(String.class)
         public enum Card { CLUBS, DIAMONDS, HEARTS, SPADES }
     
    
         <!-- Example: XML Schema fragment -->
         <xs:simpleType name="Card">
           <xs:restriction base="xs:string"/>
             <xs:enumeration value="CLUBS"/>
             <xs:enumeration value="DIAMONDS"/>
             <xs:enumeration value="HEARTS"/>
             <xs:enumeration value="SPADES"/>
         </xs:simpleType>
     

    例2: enum定数名(値) ->列挙ファセットのマップ

         //Example: code fragment
         @XmlType
         @XmlEnum(Integer.class)
         public enum Coin {
             @XmlEnumValue("1") PENNY(1),
             @XmlEnumValue("5") NICKEL(5),
             @XmlEnumValue("10") DIME(10),
             @XmlEnumValue("25") QUARTER(25) }
     
    
         <!-- Example: XML Schema fragment -->
         <xs:simpleType name="Coin">
           <xs:restriction base="xs:int">
             <xs:enumeration value="1"/>
             <xs:enumeration value="5"/>
             <xs:enumeration value="10"/>
             <xs:enumeration value="25"/>
           </xs:restriction>
         </xs:simpleType>
     

    例3: enum定数名 ->列挙ファセットへのマップ

         //Code fragment
         @XmlType
         @XmlEnum(Integer.class)
         public enum Code {
             @XmlEnumValue("1") ONE,
             @XmlEnumValue("2") TWO;
         }
     
    
         <!-- Example: XML Schema fragment -->
         <xs:simpleType name="Code">
           <xs:restriction base="xs:int">
             <xs:enumeration value="1"/>
             <xs:enumeration value="2"/>
           </xs:restriction>
         </xs:simpleType>
     
    導入されたバージョン:
    1.6, JAXB 2.0
    • 必須要素のサマリー

      必須要素 
      修飾子と型 必須要素 説明
      String value