Spec-Zone.ru › OpenJDK 8

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

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 должен быть непустым ссылкой.

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 должен быть непустым ссылкой.

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.

© 1993, 2020, 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.

Spec-Zone.ru

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