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

注釈型XmlElementWrapper



  • @Retention(RUNTIME)
    @Target({FIELD,METHOD})
    public @interface XmlElementWrapper
    XML表現にかかわるラッパー要素を生成します。 これは主に、コレクションにかかわるラッパーXML要素を生成するために使用されることを意図しています。 そのため、この注釈は、次の2つの形式の直列化をサポートしています。
    
        //Example: code fragment
          int[] names;
    
        // XML Serialization Form 1 (Unwrapped collection)
        <names> ... </names>
        <names> ... </names>
    
        // XML Serialization Form 2 ( Wrapped collection )
        <wrapperElement>
           <names> value-of-item </names>
           <names> value-of-item </names>
           ....
        </wrapperElement>
     

    この2つの直列化されたXML形式では、nillable属性を伴う要素の有無によって、nullコレクションを表現できます。

    使用法

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

    • JavaBeanプロパティ
    • staticでない非一時フィールド

    使用には次の制約があります。

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

    導入されたバージョン:
    1.6, JAXB 2.0
    関連項目:
    XmlElement, XmlElements, XmlElementRef, XmlElementRefs
    • オプション要素のサマリー

      オプションの要素 
      修飾子と型 オプション要素 説明
      String name
      XMLラッパー要素の名前です。
      String namespace
      XMLラッパー要素のXMLターゲット名前空間です。
      boolean nillable
      trueの場合、xsi:nil='true'を使用することによって、コレクションの不在が表現されます。
      boolean required
      ラッパー要素宣言をカスタマイズしてrequiredにします。
    • 要素の詳細

      • name

        String name
        XMLラッパー要素の名前です。 デフォルトでは、XMLラッパー要素名は、JavaBeanプロパティ名から派生します。
        デフォルト:
        「##default」
      • namespace

        String namespace
        XMLラッパー要素のXMLターゲット名前空間です。

        値が「##default」の場合、名前空間は次のように決定されます。

        1. それを含むパッケージにXmlSchema注釈型があり、それのelementFormDefaultQUALIFIEDの場合、それを含むクラスの名前空間。
        2. それ以外の場合、「」(これは、デフォルト名前空間に非修飾要素を生成します)。
        デフォルト:
        「##default」
      • nillable

        boolean nillable
        trueの場合、xsi:nil='true'を使用することによって、コレクションの不在が表現されます。 そうでない場合、この要素がないことによって表現されます。
        デフォルト:
        false
      • required

        boolean required
        ラッパー要素宣言をカスタマイズしてrequiredにします。

        required()がtrueの場合、生成された対応するXMLスキーマ要素宣言には、ラッパー要素が常に期待されることを示すminOccurs="1"が含まれます。

        これはスキーマの生成だけに影響を及ぼし、非整列化や整列化の機能には影響しません。 これは、ユーザーがアプリケーションの制約をより適切に表現するための手段にすぎません。

        導入されたバージョン:
        1.6, JAXB 2.1
        デフォルト:
        false