パッケージ jakarta.xml.bind

クラス JAXBElement<T>

  • 実装されたすべてのインターフェース:
    SerializableSE

    public class JAXBElement<T>
    extends ObjectSE
    implements SerializableSE

    Xml 要素の Jakarta XML Binding 表現。

    このクラスは、スキーマ内の要素宣言と xml ドキュメント内の要素インスタンス値の両方からの Xml 要素に関する情報を次のプロパティで表します。

    • 要素の xml タグ name
    • value は、要素インスタンスの属性とコンテンツモデルを表します
    • 要素宣言の declaredType (xs:element @type 属性)
    • 要素宣言の scope
    • ブール nil プロパティ。(要素インスタンスの xsi:nil 属性)

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

    Scope は、JAXBElement.GlobalScope またはスキーマ要素宣言を含む複合型定義を表す Java クラスのいずれかです。

    value が null の場合、nil は true でなければならないというプロパティの制約があります。属性を使用して nil 要素を表すことができるようにするには、その逆は当てはまりません。nil が true の場合、value が null でない可能性があるため、nil 要素に関連付けられた属性の値を保持できます。

    導入:
    1.6、JAXB 2.0
    作成者:
    Kohsuke Kawaguchi, Joe Fialli
    関連事項:
    直列化された形式
    • ネストされたクラスのサマリー

      ネストされたクラス  
      修飾子と型 クラス 説明
      static class JAXBElement.GlobalScope
      xml 要素のグローバルスコープを指定します。
    • フィールドサマリー

      フィールド  
      修飾子と型 フィールド 説明
      protected ClassSE<T>declaredType
      xml 要素宣言の型の Java データ型バインディング。
      protected QNameSEname
      xml 要素のタグ名
      protected booleannil
      xml 要素インスタンスに xsi:nil="true" がある場合は true。
      protected ClassSE<?>scope
      この xml 要素インスタンスを表す xml 要素宣言のスコープ。
      protected Tvalue
      xml 要素の値。
    • コンストラクターのサマリー

      コンストラクター  
      コンストラクター 説明
      JAXBElement​(QNameSE name, ClassSE<T> declaredType, ClassSE<?> scope, T value)
      xml 要素インスタンスを作成します。
      JAXBElement​(QNameSE name, ClassSE<T> declaredType, T value)
      xml 要素インスタンスを作成します。
    • フィールドの詳細

      • name

        protected final QNameSE name
        xml 要素のタグ名
      • declaredType

        protected final ClassSE<T> declaredType
        xml 要素宣言の型の Java データ型バインディング。
      • scope

        protected final ClassSE<?> 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​(QNameSE name,
                           ClassSE<T> declaredType,
                           ClassSE<?> scope,
                           T value)

        xml 要素インスタンスを作成します。

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

        public JAXBElement​(QNameSE name,
                           ClassSE<T> declaredType,
                           T value)
        xml 要素インスタンスを作成します。これは new JAXBElement(name,declaredType,GlobalScope.class,value) の便利なメソッドです
    • メソッドの詳細

      • getDeclaredType

        public ClassSE<T> getDeclaredType()
        xml 要素宣言の type 属性の Java バインディングを返します。
      • getName

        public QNameSE getName()
        xml 要素のタグ名を返します。
      • setValue

        public void setValue​(T t)

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

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

        関連事項:
        isTypeSubstituted()
      • getValue

        public T getValue()

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

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

      • getScope

        public ClassSE<?> 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 を返します。