アノテーション型 XmlAttribute


  • @RetentionSE(RUNTIMESE)
    @TargetSE({FIELDSE,METHODSE})
    public @interface XmlAttribute

    JavaBean プロパティを XML 属性にマップします。

    使用方法

    @XmlAttribute アノテーションは、次のプログラム要素で使用できます。

    • JavaBean プロパティ
    • フィールド

    静的 final フィールドは、XML 固定属性にマップされます。

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

    使用箇所には、次の制約があります。
    • フィールドの型またはプロパティがコレクション型の場合、コレクションアイテム型をスキーマ単純型にマップする必要があります。
           // Examples
           @XmlAttribute List<Integer> items; //legal
           @XmlAttribute List<Bar> foo; // illegal if Bar does not map to a schema simple type
       
    • フィールドまたはプロパティの型が非コレクション型の場合、プロパティまたはフィールドの型は単純なスキーマ型にマップする必要があります。
           // Examples
           @XmlAttribute int foo; // legal
           @XmlAttribute Foo foo; // illegal if Foo does not map to a schema simple type
       
    • このアノテーションは、次のアノテーションとともに使用できます: XmlIDXmlIDREFXmlListXmlSchemaTypeXmlValueXmlAttachmentRefXmlMimeTypeXmlInlineBinaryDataXmlJavaTypeAdapter

    例 1: JavaBean プロパティを XML 属性にマップします。

         //Example: Code fragment
         public class USPrice { 
             @XmlAttribute
             public java.math.BigDecimal getPrice() {...} ;
             public void setPrice(java.math.BigDecimal ) {...};
         }
     
     
         <!-- Example: XML Schema fragment -->
         <xs:complexType name="USPrice">
           <xs:sequence>
           </xs:sequence>
           <xs:attribute name="price" type="xs:decimal"/>
         </xs:complexType>
     

    例 2: JavaBean プロパティを匿名型の XML 属性にマップします。

    @XmlType の例 7 を参照してください。

    例 3: JavaBean コレクションプロパティを XML 属性にマップします。

         // Example: Code fragment
         class Foo {
             ...
             @XmlAttribute List<Integer> items;
         } 
     
     
         <!-- Example: XML Schema fragment -->
         <xs:complexType name="foo">
         	 ...
           <xs:attribute name="items">
             <xs:simpleType>
               <xs:list itemType="xs:int"/>
             </xs:simpleType>
         </xs:complexType>
    
     
    導入:
    1.6、JAXB 2.0
    作成者:
    Sekhar Vajjhala, Sun Microsystems, Inc.
    関連事項:
    XmlType
    • オプション要素のサマリー

      オプション要素  
      修飾子と型 オプションの要素 説明
      StringSEname
      XML スキーマ属性の名前。
      StringSEnamespace
      XML スキーマ属性の XML ターゲット名前空間を指定します。
      booleanrequired
      XML スキーマ属性がオプションであるか必須であるかを指定します。
    • 要素の詳細

      • name

        StringSE name
        XML スキーマ属性の名前。デフォルトでは、XML スキーマ属性名は JavaBean プロパティ名から派生しています。
        デフォルト:
        "##default"
      • required

        boolean required
        XML スキーマ属性がオプションであるか必須であるかを指定します。true の場合、JavaBean プロパティは必須の XML スキーマ属性にマップされます。それ以外の場合は、オプションの XML スキーマ属性にマップされます。
        デフォルト:
        false
      • namespace

        StringSE namespace
        XML スキーマ属性の XML ターゲット名前空間を指定します。
        デフォルト:
        "##default"