Класс XMLEventFactory

java.lang.Object

javax.xml.stream.XMLEventFactory

public abstract class XMLEventFactory extends Object

Этот интерфейс определяет утилитарный класс для создания экземпляров XMLEvents

Since:

1.6

См. также:

Краткое описание конструкторов

XMLEventFactory()

Модификатор	Конструктор	Описание
`protected`	Защищённый конструктор для предотвращения инстанцирования.

Краткое описание методов

Модификатор и тип	Метод	Описание
`abstract Attribute`	`createAttribute(String localName, String value)`	Создать новый атрибут
`abstract Attribute`	`createAttribute(String prefix, String namespaceURI, String localName, String value)`	Создать новый атрибут
`abstract Attribute`	`createAttribute(QName name, String value)`	Создать новый атрибут
`abstract Characters`	`createCData(String content)`	Создать событие Characters с флагом CData, установленным в true
`abstract Characters`	`createCharacters(String content)`	Создать событие Characters, этот метод не проверяет, содержит ли содержимое только пробелы.
`abstract Comment`	`createComment(String text)`	Создать комментарий.
`abstract DTD`	`createDTD(String dtd)`	Создать событие определения типа документа. Эта строка содержит полное объявление типа документа, соответствующее доctypedecl в спецификации XML 1.0
`abstract EndDocument`	`createEndDocument()`	Создаёт новый экземпляр события EndDocument
`abstract EndElement`	`createEndElement(String prefix, String namespaceUri, String localName)`	Создать новый EndElement
`abstract EndElement`	`createEndElement(String prefix, String namespaceUri, String localName, Iterator<? extends Namespace> namespaces)`	Создать новый EndElement
`abstract EndElement`	`createEndElement(QName name, Iterator<? extends Namespace> namespaces)`	Создать новый EndElement
`abstract EntityReference`	`createEntityReference(String name, EntityDeclaration declaration)`	Создаёт новый экземпляр события EntityReference
`abstract Characters`	`createIgnorableSpace(String content)`	Создать игнорируемое пространство
`abstract Namespace`	`createNamespace(String namespaceURI)`	Создать новый пространство имён по умолчанию
`abstract Namespace`	`createNamespace(String prefix, String namespaceUri)`	Создать новое пространство имён
`abstract ProcessingInstruction`	`createProcessingInstruction(String target, String data)`	Создать инструкцию обработки
`abstract Characters`	`createSpace(String content)`	Создать событие Characters с флагом isSpace, установленным в true
`abstract StartDocument`	`createStartDocument()`	Создаёт новый экземпляр события StartDocument
`abstract StartDocument`	`createStartDocument(String encoding)`	Создаёт новый экземпляр события StartDocument
`abstract StartDocument`	`createStartDocument(String encoding, String version)`	Создаёт новый экземпляр события StartDocument
`abstract StartDocument`	`createStartDocument(String encoding, String version, boolean standalone)`	Создаёт новый экземпляр события StartDocument
`abstract StartElement`	`createStartElement(String prefix, String namespaceUri, String localName)`	Создать новый StartElement.
`abstract StartElement`	`createStartElement(String prefix, String namespaceUri, String localName, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces)`	Создать новый StartElement.
`abstract StartElement`	`createStartElement(String prefix, String namespaceUri, String localName, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces, NamespaceContext context)`	Создать новый StartElement.
`abstract StartElement`	`createStartElement(QName name, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces)`	Создать новый StartElement.
`static XMLEventFactory`	`newDefaultFactory()`	Создаёт новый экземпляр встроенной реализации по умолчанию `XMLEventFactory`.
`static XMLEventFactory`	`newFactory()`	Создаёт новый экземпляр фабрики.
`static XMLEventFactory`	`newFactory(String factoryId, ClassLoader classLoader)`	Создаёт новый экземпляр фабрики.
`static XMLEventFactory`	`newInstance()`	Создаёт новый экземпляр фабрики точно так же, как и метод `newFactory()`.
`static XMLEventFactory`	`newInstance(String factoryId, ClassLoader classLoader)`	Устарело. Этот метод устарел для сохранения согласованности API.
`abstract void`	`setLocation(Location location)`	Этот метод позволяет установить Location для каждого события, созданного этой фабрикой.

Методы, объявленные в классе java.lang.Object

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

Подробное описание конструкторов

XMLEventFactory

protected XMLEventFactory()

Защищённый конструктор для предотвращения создания экземпляров. Используйте newFactory() вместо него.

Подробное описание методов

newDefaultFactory

public static XMLEventFactory newDefaultFactory()

Создаёт новый экземпляр реализации XMLEventFactory по умолчанию.

Возвращает:: Новый экземпляр реализации XMLEventFactory по умолчанию.
С:: 9

newInstance

public static XMLEventFactory newInstance() throws FactoryConfigurationError

Создаёт новый экземпляр фабрики точно так же, как и метод newFactory().

Возвращает:: экземпляр XMLEventFactory
Издаёт:: FactoryConfigurationError - если экземпляр этой фабрики не может быть загружен

newFactory

public static XMLEventFactory newFactory() throws FactoryConfigurationError

Создаёт новый экземпляр фабрики. Этот метод использует механизм поиска JAXP JAXP Lookup Mechanism, чтобы определить класс реализации XMLEventFactory для загрузки.

После того, как приложение получило ссылку на XMLEventFactory, оно может использовать фабрику для конфигурации и получения экземпляров потоков.

Возвращает:: экземпляр XMLEventFactory
Издаёт:: FactoryConfigurationError - в случае ошибки конфигурации службы или если реализация недоступна или не может быть создана.

newInstance

@Deprecated(since="1.7") public static XMLEventFactory newInstance(String factoryId, ClassLoader classLoader) throws FactoryConfigurationError

Устарело.

Этот метод устарел для поддержания согласованности API. Все методы newInstance были заменены соответствующими методами newFactory. Замена newFactory(java.lang.String, java.lang.ClassLoader) метода не меняет поведение.

Создаёт новый экземпляр фабрики

Параметры:: factoryId - Имя фабрики для поиска, совпадает с именем свойства; classLoader - classLoader для использования
Возвращает:: реализация фабрики
Издаёт:: FactoryConfigurationError - если экземпляр этой фабрики не может быть загружен

newFactory

public static XMLEventFactory newFactory(String factoryId, ClassLoader classLoader) throws FactoryConfigurationError

Создаёт новый экземпляр фабрики. Если аргумент classLoader равен null, используется ContextClassLoader.

Этот метод использует следующую упорядоченную процедуру поиска, чтобы определить класс реализации XMLEventFactory для загрузки:

Используйте значение системной переменной, идентифицированной по factoryId.
Используйте файл конфигурации "stax.properties". Файл имеет стандартный Properties формат и обычно находится в каталоге conf установки Java. Он содержит полное имя класса реализации, причём ключ — это системная переменная, определённая выше.

Файл stax.properties читается реализацией только один раз, а его значения кэшируются для последующего использования. Если файла не существует при первой попытке чтения, дальнейшие попытки проверки его существования не предпринимаются. Изменить значение любого свойства в stax.properties после его первого прочтения нельзя.

Используйте файл конфигурации jaxp "jaxp.properties". Файл имеет такой же формат, как и stax.properties, и будет прочитан только если stax.properties не существует.
Если factoryId равен "javax.xml.stream.XMLEventFactory", используйте механизм загрузки поставщиков услуг, определённый классом ServiceLoader, чтобы попытаться найти и загрузить реализацию службы с использованием указанного ClassLoader. Если classLoader равно null, применяется механизм загрузки по умолчанию: механизм загрузки поставщиков услуг будет использовать текущий контекстный класс загрузчик потока для попытки загрузки службы. Если контекстный класс загрузчик равен null, будет использован системный класс загрузчик.
В противном случае, выбрасывается FactoryConfigurationError.

Обратите внимание, что это новый метод, который заменяет устаревший newInstance(String factoryId, ClassLoader classLoader) метод. Этот заменяющий метод не изменяет поведение по сравнению с устаревшим методом.

Примечание API:: Параметр factoryId здесь не соответствует таковому в других фабриках JAXP, где первый параметр — полное квалифицированное имя класса фабрики, предоставляющего реализацию фабрики.
Параметры:: factoryId - Имя фабрики для поиска, совпадает с именем свойства; classLoader - classLoader для использования
Возвращает:: реализация фабрики
Издаёт:: FactoryConfigurationError - в случае ошибки конфигурации службы или если реализация недоступна или не может быть создана.

setLocation

public abstract void setLocation(Location location)

Этот метод позволяет установить Location для каждого события, создаваемого этой фабрикой. Значения копируются по значению в события, создаваемые этой фабрикой. Для сброса информации о местоположении установите location в null.

Параметры:: location - местоположение, которое нужно установить для каждого создаваемого события

createAttribute

public abstract Attribute createAttribute(String prefix, String namespaceURI, String localName, String value)

Создаёт новый атрибут

Параметры:: prefix - префикс этого атрибута, не может быть null; namespaceURI - значение атрибута, устанавливается в это значение, не может быть null; localName - локальное имя XML-имени атрибута, localName не может быть null; value - значение атрибута, которое нужно установить, не может быть null
Возвращает:: атрибут со значениями

createAttribute

public abstract Attribute createAttribute(String localName, String value)

Создаёт новый атрибут

Параметры:: localName - локальное имя XML-имени атрибута, localName не может быть null; value - значение атрибута, которое нужно установить, не может быть null
Возвращает:: атрибут со значениями

createAttribute

public abstract Attribute createAttribute(QName name, String value)

Создаёт новый атрибут

Параметры:: name - полное имя атрибута, не может быть null; value - значение атрибута, которое нужно установить, не может быть null
Возвращает:: атрибут со значениями

createNamespace

public abstract Namespace createNamespace(String namespaceURI)

Создаёт новый глобальный Namespace

Параметры:: namespaceURI - uri глобального namespace
Возвращает:: Namespace со значением

createNamespace

public abstract Namespace createNamespace(String prefix, String namespaceUri)

Создаёт новый Namespace

Параметры:: prefix - префикс этого namespace, не может быть null; namespaceUri - значение атрибута, устанавливается в это значение, не может быть null
Возвращает:: Namespace со значениями

createStartElement

public abstract StartElement createStartElement(QName name, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces)

Создаёт новый StartElement. Namespace можно добавить в этот StartElement, передав Iterator, который перебирает набор интерфейсов Namespace. Атрибуты можно добавить в этот StartElement, передав Iterator, который перебирает набор интерфейсов Attribute.

Параметры:: name - полное имя атрибута, не может быть null; attributes - необязательный неупорядоченный набор объектов, реализующих Attribute, для добавления в новый StartElement, может быть null; namespaces - необязательный неупорядоченный набор объектов, реализующих Namespace, для добавления в новый StartElement, может быть null
Возвращает:: экземпляр запрошенного StartElement

createStartElement

public abstract StartElement createStartElement(String prefix, String namespaceUri, String localName)

Создаёт новый StartElement. По умолчанию NamespaceContext устанавливается в пустой NamespaceContext. Обращение к этому событию для получения его namespaces или attributes вернёт пустой Iterator.

Параметры:: namespaceUri - uri QName нового StartElement; localName - локальное имя QName нового StartElement; prefix - префикс QName нового StartElement
Возвращает:: экземпляр запрошенного StartElement

createStartElement

public abstract StartElement createStartElement(String prefix, String namespaceUri, String localName, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces)

Создать новый элемент StartElement. Пространства имён можно добавить в этот StartElement, передав итератор, который проходит по набору интерфейсов Namespace. Атрибуты можно добавить в этот StartElement, передав итератор, который проходит по набору интерфейсов Attribute.

Parameters:: namespaceUri - uri имени QName нового StartElement; localName - локальное имя QName нового StartElement; prefix - префикс имени QName нового StartElement; attributes - неупорядоченный набор объектов, реализующих интерфейс Attribute, для добавления в новый StartElement; namespaces - неупорядоченный набор объектов, реализующих интерфейс Namespace, для добавления в новый StartElement
Returns:: экземпляр запрошенного StartElement

createStartElement

public abstract StartElement createStartElement(String prefix, String namespaceUri, String localName, Iterator<? extends Attribute> attributes, Iterator<? extends Namespace> namespaces, NamespaceContext context)

Parameters:: namespaceUri - uri имени QName нового StartElement; localName - локальное имя QName нового StartElement; prefix - префикс имени QName нового StartElement; attributes - неупорядоченный набор объектов, реализующих интерфейс Attribute, для добавления в новый StartElement, может быть null; namespaces - неупорядоченный набор объектов, реализующих интерфейс Namespace, для добавления в новый StartElement, может быть null; context - контекст пространства имён этого элемента
Returns:: экземпляр запрошенного StartElement

createEndElement

public abstract EndElement createEndElement(QName name, Iterator<? extends Namespace> namespaces)

Создать новый элемент EndElement

Parameters:: name - полное имя EndElement; namespaces - необязательный неупорядоченный набор объектов, реализующих интерфейс Namespace, вышедших из области видимости, может быть null
Returns:: экземпляр запрошенного EndElement

createEndElement

public abstract EndElement createEndElement(String prefix, String namespaceUri, String localName)

Создать новый элемент EndElement

Parameters:: namespaceUri - uri имени QName нового элемента; localName - локальное имя QName нового элемента; prefix - префикс имени QName нового элемента
Returns:: экземпляр запрошенного EndElement

createEndElement

public abstract EndElement createEndElement(String prefix, String namespaceUri, String localName, Iterator<? extends Namespace> namespaces)

Создать новый элемент EndElement

Parameters:: namespaceUri - uri имени QName нового элемента; localName - локальное имя QName нового элемента; prefix - префикс имени QName нового элемента; namespaces - неупорядоченный набор объектов, реализующих интерфейс Namespace, вышедших из области видимости, может быть null
Returns:: экземпляр запрошенного EndElement

createCharacters

public abstract Characters createCharacters(String content)

Создать событие Characters, этот метод не проверяет, является ли содержимое только пробелами. Для создания события пробела используйте #createSpace(String)

Parameters:: content - строка для создания
Returns:: событие Characters

createCData

public abstract Characters createCData(String content)

Создать событие Characters с флагом CData, установленным в true

Parameters:: content - строка для создания
Returns:: событие Characters

createSpace

public abstract Characters createSpace(String content)

Создать событие Characters с флагом isSpace, установленным в true

Parameters:: content - содержимое пробела для создания
Returns:: событие Characters

createIgnorableSpace

public abstract Characters createIgnorableSpace(String content)

Создать игнорируемый пробел

Parameters:: content - пробел для создания
Returns:: событие Characters

createStartDocument

public abstract StartDocument createStartDocument()

Создаёт новый экземпляр события StartDocument

Returns:: событие StartDocument

createStartDocument

public abstract StartDocument createStartDocument(String encoding, String version, boolean standalone)

Создаёт новый экземпляр события StartDocument

Parameters:: encoding - стиль кодирования; version - версия XML; standalone - состояние автономного режима, может быть "true" или "false"
Returns:: событие StartDocument

createStartDocument

public abstract StartDocument createStartDocument(String encoding, String version)

Создаёт новый экземпляр события StartDocument

Parameters:: encoding - стиль кодирования; version - версия XML
Returns:: событие StartDocument

createStartDocument

public abstract StartDocument createStartDocument(String encoding)

Создаёт новый экземпляр события StartDocument

Parameters:: encoding - стиль кодирования
Returns:: событие StartDocument

createEndDocument

public abstract EndDocument createEndDocument()

Создаёт новый экземпляр события EndDocument

Returns:: событие EndDocument

createEntityReference

public abstract EntityReference createEntityReference(String name, EntityDeclaration declaration)

Создаёт новый экземпляр события EntityReference

Parameters:: name - имя ссылки; declaration - объявление для события
Returns:: событие EntityReference

createComment

public abstract Comment createComment(String text)

Создать комментарий.

Parameters:: text - текст комментария
Returns:: событие Comment

createProcessingInstruction

public abstract ProcessingInstruction createProcessingInstruction(String target, String data)

Создать инструкцию обработки

Parameters:: target - целевой объект инструкции обработки; data - текст инструкции обработки
Returns:: событие ProcessingInstruction

createDTD

public abstract DTD createDTD(String dtd)

Создать событие определения типа документа. Эта строка содержит полное объявление типа документа, соответствующее doctypedecl в спецификации XML 1.0

Parameters:: dtd - текст определения типа документа
Returns:: событие DTD

© 1993, 2021, 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/17/docs/api/java.xml/javax/xml/stream/XMLEventFactory.html