Spec-Zone.ru › OpenJDK 8

Класс JAXBElement<T>

  • java.lang.Object
    • javax.xml.bind.JAXBElement<T>
Все реализованные интерфейсы:
Serializable

public class JAXBElement<T>
extends Object
implements Serializable

JAXB-представление XML-элемента.

Этот класс представляет информацию об XML-элементе, как из объявления элемента в схеме, так и из значения экземпляра элемента в XML-документе, с такими свойствами:

  • тэг XML-элемента name
  • value представляет атрибуты(ы) и модель содержимого экземпляра элемента
  • объявление элемента declaredType (атрибут xs:element @type)
  • scope объявления элемента
  • логическое свойство nil. (атрибут xsi:nil экземпляра элемента)

Свойства declaredType и scope являются привязкой JAXB-класса к определению типа XML.

Scope является либо JAXBElement.GlobalScope, либо Java-класс, представляющий определение комплексного типа, содержащего объявление схемы элемента.

Существует ограничение на свойства, что если value равно null, то nil должно быть true. Обратное неверно, чтобы можно было представить элемент nil с атрибутами(ами). Если nil равно true, то возможно value не равно null, чтобы хранить значение атрибутов, связанных с элементом nil.

С тех пор, как:
JAXB 2.0
См. также:
Сериализованная форма

Вложенные классы

Модификатор и тип Класс и описание
static class  JAXBElement.GlobalScope

Обозначает глобальную область видимости XML-элемента.

Сводка полей

Модификатор и тип Поле и описание
protected Class<T> declaredType

Связывание Java-данных для типа объявления XML-элемента.

protected QName name

Имя тега XML-элемента.

protected boolean nil

Истинно, если у экземпляра XML-элемента xsi:nil="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()

Возвращает Java-привязку атрибута типа объявления XML-элемента.

QName getName()

Возвращает имя тега XML-элемента.

Class getScope()

Возвращает область видимости объявления XML-элемента.

T getValue()

Возвращает модель содержимого и значения атрибутов для данного элемента.

boolean isGlobalScope()

Возвращает true, если объявление XML-элемента глобальное.

boolean isNil()

Возвращает true, если модель содержимого этого экземпляра элемента — nil.

boolean isTypeSubstituted()

Возвращает true, если значение этого экземпляра XML-элемента имеет другой тип, чем тип, объявленный в схеме элемента.

void setNil(boolean value)

Устанавливает, имеет ли этот элемент содержимое nil.

void setValue(T t)

Устанавливает модель содержимого и атрибуты этого XML-элемента.

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

name

protected final QName name

Имя тега XML-элемента

declaredType

protected final Class<T> declaredType

Связывание Java-данных для типа объявления XML-элемента.

scope

protected final Class scope

Область видимости объявления XML-элемента, представляющего данный экземпляр XML-элемента. Может принимать следующие значения: - JAXBElement.GlobalScope для глобального объявления XML-элемента. - локальное объявление элемента имеет область видимости, установленную в Java-класс, представляющий определение комплексного типа, содержащего объявление XML-элемента.

value

protected T value

Значение XML-элемента. Представляет модель содержимого и атрибуты экземпляра XML-элемента.

nil

protected boolean nil

Истинно, если у экземпляра XML-элемента xsi:nil="true".

Подробное описание конструкторов

JAXBElement

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

Создаёт экземпляр XML-элемента.

Параметры:
name - Java-привязка имени тега XML-элемента
declaredType - Java-привязка типа объявления XML-элемента
scope - Java-привязка области видимости объявления XML-элемента. Передача null эквивалентна передаче GlobalScope.class
value - Java-экземпляр, представляющий значение XML-элемента.
См. также:
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()

Возвращает Java-привязку атрибута типа объявления XML-элемента.

getName

public QName getName()

Возвращает имя тега XML-элемента.

setValue

public void setValue(T t)

Устанавливает модель содержимого и атрибуты этого XML-элемента.

Когда это свойство установлено в null, isNil() должно быть true. Подробности ограничения описаны в isNil().

См. также:
isTypeSubstituted()

getValue

public T getValue()

Возвращает модель содержимого и значения атрибутов для этого элемента.

См. isNil() для описания ограничения свойства, когда это значение равно null

getScope

public Class getScope()

Возвращает область видимости объявления XML-элемента.

Возвращает:
GlobalScope.class если этот элемент имеет глобальную область видимости.
См. также:
isGlobalScope()

isNil

public boolean isNil()

Возвращает true если модель содержимого данного экземпляра элемента — nil.

Это свойство всегда возвращает true когда getValue() равно null. Обратите внимание, что обратное неверно: когда это свойство равно true, getValue() может содержать ненулевое значение для атрибутов. Для элемента nil допустимо наличие атрибутов.

setNil

public void setNil(boolean value)

Устанавливает, имеет ли этот элемент содержимое nil.

См. также:
isNil()

isGlobalScope

public boolean isGlobalScope()

Возвращает true, если это объявление XML-элемента является глобальным.

isTypeSubstituted

public boolean isTypeSubstituted()

Возвращает true, если значение этого экземпляра XML-элемента имеет другой тип, чем тип, объявленный в схеме элемента.

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API