Class 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` явная установка системного идентификатора не допускается.

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

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли какой-либо другой объект этому.
`protected void`	`finalize()`	Устарело, для удаления: этот элемент API подлежит удалению в будущей версии. Финализация устарела и подлежит удалению в будущей версии.
`final Class<?>`	`getClass()`	Возвращает класс среды выполнения для этого `Object`.
`int`	`hashCode()`	Возвращает значение хэш-кода для объекта.
`final void`	`notify()`	Возобновляет работу одного потока, ожидающего на мониторе этого объекта.
`final void`	`notifyAll()`	Возобновляет работу всех потоков, ожидающих на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать, пока он не будет разбужен, обычно посредством оповещения или прерывания.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать, пока он не будет разбужен, обычно посредством оповещения или прерывания, либо пока не истечет заданное количество реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать, пока он не будет разбужен, обычно посредством оповещения или прерывания, либо пока не истечет заданное количество реального времени.

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

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.