javax.xml.bind.annotation

注釈型 XmlElementWrapper

@Retention(value=RUNTIME)
@Target(value={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 でない非一時フィールド

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

• プロパティーは、コレクションプロパティーである必要があります。
• この注釈型は、次の注釈型とともに使用できます。XmlElement、XmlElements、XmlElementRef、XmlElementRefs、XmlJavaTypeAdapter。

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

導入されたバージョン:

JAXB2.0

関連項目:

XmlElement, XmlElements, XmlElementRef, XmlElementRefs

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

オプションの要素

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

要素の詳細

name

public abstract String name

XML ラッパー要素の名前です。デフォルトでは、XML ラッパー要素名は、JavaBean プロパティー名から派生します。

デフォルト:

「##default」

namespace

public abstract String namespace

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

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

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

デフォルト:

「##default」

nillable

public abstract boolean nillable

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

デフォルト:

false

required

public abstract boolean required

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

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

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

導入されたバージョン:

JAXB 2.1

デフォルト:

false