Класс StAXSource

java.lang.Object
- javax.xml.transform.stax.StAXSource

Все реализованные интерфейсы:: Source

public class StAXSource
extends Object
implements Source

Действует как контейнер для XML-Source в виде StAX-ридера, т. е. XMLStreamReader или XMLEventReader. StAXSource можно использовать во всех случаях, которые принимают Source, например, Transformer, Validator, принимающие Source в качестве входных данных.

StAXSource потребляются во время обработки и не являются многоразовыми.

С тех пор:: 1.6
См. также:: JSR 173: Потоковый API для XML, XMLStreamReader, XMLEventReader

Поля

Модификатор и тип	Поле	Описание
`static String`	`FEATURE`	Если `TransformerFactory.getFeature(String name)` возвращает true при передаче этого значения в качестве аргумента, трансформер поддерживает входной тип Source.

Конструкторы

Конструктор	Описание
`StAXSource(XMLEventReader xmlEventReader)`	Создает новый экземпляр `StAXSource`, передавая `XMLEventReader`.
`StAXSource(XMLStreamReader xmlStreamReader)`	Создает новый экземпляр `StAXSource`, передавая `XMLStreamReader`.

Методы

Модификатор и тип	Метод	Описание
`String`	`getSystemId()`	Получить идентификатор системы, используемый данным `StAXSource`.
`XMLEventReader`	`getXMLEventReader()`	Получить `XMLEventReader`, используемый этим `StAXSource`.
`XMLStreamReader`	`getXMLStreamReader()`	Получить `XMLStreamReader`, используемый этим `StAXSource`.
`boolean`	`isEmpty()`	Указывает, является ли объект `StAXSource` пустым.
`void`	`setSystemId(String systemId)`	В контексте `StAXSource`, явное задание идентификатора системы некорректно.

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

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

Поля

FEATURE

public static final String FEATURE

Если TransformerFactory.getFeature(String name) возвращает true при передаче этого значения в качестве аргумента, трансформер поддерживает входной тип Source.

См. также:: Постоянные значения полей

Конструкторы

StAXSource

public StAXSource(XMLEventReader xmlEventReader)
           throws XMLStreamException

Создает новый экземпляр StAXSource, передавая XMLEventReader.

XMLEventReader должен быть ссылкой, отличной от null.

XMLEventReader должен находиться в состоянии XMLStreamConstants.START_DOCUMENT или XMLStreamConstants.START_ELEMENT.

Параметры:: xmlEventReader - XMLEventReader, используемый для создания данного StAXSource.
Исключения:: XMLStreamException - Если доступ к xmlEventReader вызывает Exception.; IllegalArgumentException - Если xmlEventReader == null.; IllegalStateException - Если xmlEventReader не находится в состоянии XMLStreamConstants.START_DOCUMENT или XMLStreamConstants.START_ELEMENT.

StAXSource

public StAXSource(XMLStreamReader xmlStreamReader)

Создает новый экземпляр StAXSource, передавая XMLStreamReader.

XMLStreamReader должен быть ссылкой, отличной от null.

XMLStreamReader должен находиться в состоянии XMLStreamConstants.START_DOCUMENT или XMLStreamConstants.START_ELEMENT.

Параметры:: xmlStreamReader - XMLStreamReader, используемый для создания данного StAXSource.
Исключения:: IllegalArgumentException - Если xmlStreamReader == null.; IllegalStateException - Если xmlStreamReader не находится в состоянии XMLStreamConstants.START_DOCUMENT или XMLStreamConstants.START_ELEMENT.

Методы

getXMLEventReader

public XMLEventReader getXMLEventReader()

Получить XMLEventReader, используемый этим StAXSource.

XMLEventReader будет null, если этот StAXSource был создан с помощью XMLStreamReader.

Возвращает:: XMLEventReader, используемый этим StAXSource.

getXMLStreamReader

public XMLStreamReader getXMLStreamReader()

Получить XMLStreamReader, используемый этим StAXSource.

XMLStreamReader будет null, если этот StAXSource был создан с помощью XMLEventReader.

Возвращает:: XMLStreamReader, используемый этим StAXSource.

setSystemId

public void setSystemId(String systemId)

В контексте StAXSource, явное задание идентификатора системы некорректно. XMLStreamReader или XMLEventReader, используемые для создания этого StAXSource, определяют идентификатор системы XML-источника.

Метод всегда выбрасывает UnsupportedOperationException.

Указано в:: setSystemId в интерфейсе Source
Параметры:: systemId - Игнорируется.
Исключения:: UnsupportedOperationException - Всегда выбрасывается этим методом.

getSystemId

public String getSystemId()

Получить идентификатор системы, используемый данным StAXSource.

Запрос идентификатора системы выполняется к XMLStreamReader или XMLEventReader для определения идентификатора системы XML-источника.

Идентификатор системы может быть null или пустой "" String.

Указано в:: getSystemId в интерфейсе Source
Возвращает:: Идентификатор системы, используемый данным StAXSource.

isEmpty

public boolean isEmpty()

Указывает, является ли объект StAXSource пустым. Так как объект StAXSource никогда не может быть пустым, этот метод всегда возвращает false.

Указано в:: isEmpty в интерфейсе Source
Возвращает:: безусловно false