Класс 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 при передаче этого значения в качестве аргумента, трансформер поддерживает вход 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, используемые для создания этого StAXSource запрашиваются для определения идентификатора системы XML-источника.

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

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

isEmpty

public boolean isEmpty()

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

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

© 1993, 2023, 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/21/docs/api/java.xml/javax/xml/transform/stax/StAXSource.html