Spec-Zone.ru › OpenJDK 24

Класс 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: Streaming API для XML
  • XMLStreamReader
  • XMLEventReader

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

Модификатор и тип Поле Описание
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, 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://download.java.net/java/early_access/jdk24/docs/api/java.xml/javax/xml/transform/stax/StAXSource.html

Spec-Zone.ru

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