Класс 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

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final String`	`FEATURE`	Если `TransformerFactory.getFeature(String name)` возвращает true при передаче этого значения в качестве аргумента, то Transformer поддерживает входные данные типа 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 при передаче этого значения в качестве аргумента, то Transformer поддерживает входные данные типа 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 явная установка системного идентификатора не допускается. Системный идентификатор источника XML определяется ридером XMLStreamReader или XMLEventReader, использованным при создании этого объекта StAXSource.

Этот метод всегда выбрасывает исключение UnsupportedOperationException.

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

getSystemId

public String getSystemId()

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

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

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

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

isEmpty

public boolean isEmpty()

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

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

© 1993, 2025, 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.xml/javax/xml/transform/stax/StAXSource.html