アノテーション型 XmlElementWrapper


  • @RetentionSE(RUNTIMESE)
    @TargetSE({FIELDSE,METHODSE})
    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 形式を使用すると、null コレクションを nillable 属性を持つ要素の有無で表すことができます。

    使用方法

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

    • JavaBean プロパティ
    • 非静的、非一時的なフィールド

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

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

    導入:
    1.6、JAXB 2.0
    作成者:
    • Kohsuke Kawaguchi, Sun Microsystems, Inc.
    • Sekhar Vajjhala, Sun Microsystems, Inc.
    関連事項:
    XmlElement, XmlElements, XmlElementRef, XmlElementRefs
    • オプション要素のサマリー

      オプション要素  
      修飾子と型 オプションの要素 説明
      StringSEname
      XML ラッパー要素の名前。
      StringSEnamespace
      XML ラッパー要素の XML ターゲット名前空間。
      booleannillable
      true の場合、コレクションがないことは xsi:nil='true' を使用して表されます。
      booleanrequired
      必要に応じてラッパー要素宣言をカスタマイズします。
    • 要素の詳細

      • name

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

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

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

        1. 囲んでいるパッケージに XmlSchema アノテーションがあり、その elementFormDefaultQUALIFIED である場合、囲んでいるクラスの名前空間。
        2. それ以外の場合は ""(デフォルトの名前空間に非修飾要素を生成します)。
        デフォルト:
        "##default"
      • nillable

        boolean nillable
        true の場合、コレクションがないことは xsi:nil='true' を使用して表されます。それ以外の場合は、要素がないことで表されます。
        デフォルト:
        false
      • required

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

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

        これはスキーマの生成にのみ影響し、アンマーシャリングまたはマーシャリング機能には影響しないことに注意してください。これは、ユーザーがアプリケーションの制約をより適切に表現できるようにするためのメカニズムにすぎません。

        導入:
        1.6、JAXB 2.1
        デフォルト:
        false