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

クラスJAXBElement<T>

  • すべての実装されたインタフェース:
    Serializable
    public class JAXBElement<T>
extends Object
implements Serializable

    XML要素のJAXB表現です。

    このクラスは、次のプロパティを含む、スキーマ内の要素宣言とXML文書内の要素インスタンス値の両方からのXML要素情報を表現します。

    • 要素のXMLタグname
    • 要素インスタンスの属性およびコンテンツ・モデルを表すvalue
    • 要素宣言のdeclaredType (xs:element@type属性)
    • 要素宣言のscope
    • boolean nilプロパティ。(要素インスタンスxsi:nil属性)

    declaredTypeおよびscopeプロパティは、XML型定義に対するJAXBクラスのバインディングです。

    scopeは、JAXBElement.GlobalScopeか、スキーマ要素宣言を含む複合型定義を表すJavaクラスです。

    valueがnullの場合、nilがtrueでなければならないというプロパティ制約があります。 属性を伴うnil要素の表現を有効にするために、この逆は真ではありません。 nilがtrueの場合、valueはnull以外も可能であり、nil要素に関連付けられた属性の値を保持できます。

    導入されたバージョン:
    1.6, JAXB 2.0
    関連項目:
    直列化された形式

    • ネストされたクラスのサマリー

      ネストされたクラス 
      修飾子と型 クラス 説明
      static class  JAXBElement.GlobalScope
      XML要素のグローバル・スコープを指定します。

    • フィールドのサマリー

      フィールド 
      修飾子と型 フィールド 説明
      protected Class<T> declaredType
      XML要素宣言の型に対するJavaデータ型のバインディング。
      protected QName name
      XML要素のタグ名
      protected boolean nil
      XML要素インスタンスがxsi:nil="true"の場合、true。
      protected Class scope
      このXML要素インスタンスを表すXML要素宣言のスコープです。
      protected T value
      XML要素値。

    • コンストラクタのサマリー

      コンストラクタ 
      コンストラクタ 説明
      JAXBElement​(QName name, Class<T> declaredType, Class scope, T value)
      XML要素インスタンスを構築します。
      JAXBElement​(QName name, Class<T> declaredType, T value)
      XML要素インスタンスを構築します。

    • メソッドのサマリー

      すべてのメソッド インスタンス・メソッド 具象メソッド 
      修飾子と型 メソッド 説明
      Class<T> getDeclaredType()
      XML要素宣言の型属性のJavaバインディングを返します。
      QName getName()
      XML要素のタグ名を返します。
      Class getScope()
      XML要素宣言のスコープを返します。
      T getValue()
      この要素のコンテンツ・モデルと属性値を返します。
      boolean isGlobalScope()
      このXML要素宣言がグローバルの場合、trueを返します。
      boolean isNil()
      この要素インスタンスのコンテンツ・モデルがnilの場合、trueを返します。
      boolean isTypeSubstituted()
      このXML要素インスタンスの値がXML要素宣言の宣言型と異なる型を持つ場合、trueを返します。
      void setNil​(boolean value)
      この要素がnilコンテンツを持つかどうかを設定します。
      void setValue​(T t)
      このXML要素のコンテンツ・モデルと属性を設定します。

    • フィールドの詳細

      • name

        protected final QName name
        XML要素のタグ名

      • declaredType

        protected final Class<T> declaredType
        XML要素宣言の型に対するJavaデータ型のバインディング。

      • scope

        protected final Class scope
        このXML要素インスタンスを表すXML要素宣言のスコープです。 値は次のいずれかです。- グローバルXML要素宣言の場合、JAXBElement.GlobalScope。ローカル要素宣言の場合、XML要素宣言を含む複合型定義のJavaクラス表現に対して設定されたスコープがあります。

      • value

        protected T value
        XML要素値。 XML要素インスタンスのコンテンツ・モデルと属性を表します。

      • nil

        protected boolean nil
        XML要素インスタンスがxsi:nil="true"の場合、true。

    • コンストラクタの詳細

      • JAXBElement

        public JAXBElement​(QName name,
                   Class<T> declaredType,
                   Class scope,
                   T value)

        XML要素インスタンスを構築します。

        パラメータ:
        name - XML要素タグ名のJavaバインディング
        declaredType - XML要素宣言の型のJavaバインディング
        scope - XML要素宣言のスコープのJavaバインディング。 nullを渡すことは、GlobalScope.classを渡すことと同じ
        value - XML要素の値を表すJavaインスタンス。
        関連項目:
        getScope(), isTypeSubstituted()

      • JAXBElement

        public JAXBElement​(QName name,
                   Class<T> declaredType,
                   T value)
        XML要素インスタンスを構築します。 これは、new JAXBElement(name,declaredType,GlobalScope.class,value)の簡易メソッドです。

    • メソッドの詳細

      • getDeclaredType

        public Class<T> getDeclaredType()
        XML要素宣言の型属性のJavaバインディングを返します。

      • getName

        public QName getName()
        XML要素のタグ名を返します。

      • setValue

        public void setValue​(T t)

        このXML要素のコンテンツ・モデルと属性を設定します。

        このプロパティがnullに設定される場合、isNil()はtrueである必要があります。 制約の詳細は、isNil()で説明されています。

        関連項目:
        isTypeSubstituted()

      • getValue

        public T getValue()

        この要素のコンテンツ・モデルと属性値を返します。

        この値がnullの場合のプロパティ制約については、isNil()を参照してください。

      • getScope

        public Class getScope()
        XML要素宣言のスコープを返します。
        戻り値:
        この要素がグローバル・スコープの場合、GlobalScope.class。
        関連項目:
        isGlobalScope()

      • isNil

        public boolean isNil()

        この要素インスタンスのコンテンツ・モデルがnilの場合、trueを返します。

        getValue()がnullの場合、このプロパティは常にtrueを返します。 この逆は真ではありません。このプロパティがtrueの場合でも、getValue()にnull以外の属性値が含まれることがあります。 nil XML要素が属性を持つことは有効です。

      • setNil

        public void setNil​(boolean value)

        この要素がnilコンテンツを持つかどうかを設定します。

        関連項目:
        isNil()

      • isGlobalScope

        public boolean isGlobalScope()
        このXML要素宣言がグローバルの場合、trueを返します。

      • isTypeSubstituted

        public boolean isTypeSubstituted()
        このXML要素インスタンスの値がXML要素宣言の宣言型と異なる型を持つ場合、trueを返します。