Класс XMLEventFactory

java.lang.Object

javax.xml.stream.XMLEventFactory

public abstract class XMLEventFactory extends Object

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

Начиная с:

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)`	Создаёт событие определения типа документа. Эта строка содержит всё объявление типа документа, соответствующее doctypedecl в спецификации 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 для каждого события, создаваемого этой фабрикой.

Методы, объявленные в классе 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()`	Приостанавливает текущий поток до его пробуждения, обычно посредством вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Приостанавливает текущий поток до его пробуждения, обычно посредством вызова notify или interrupt, либо до истечения заданного времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Приостанавливает текущий поток до его пробуждения, обычно посредством вызова notify или interrupt, либо до истечения заданного времени.

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

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 для определения класса реализации 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 - используемый загрузчик классов
Возвращает:: реализацию фабрики
Выбрасывает:: FactoryConfigurationError - если не удаётся загрузить экземпляр этой фабрики

newFactory

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

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

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

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

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

Примечание API:: Параметр factoryId, определённый здесь, не согласуется с параметрами других фабрик JAXP, где первым параметром является полное имя класса фабрики, предоставляющего её реализацию.
Параметры:: factoryId - имя искомой фабрики, совпадающее с именем свойства; 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)

Создаёт новое пространство имён по умолчанию

Параметры:: namespaceURI - URI пространства имён по умолчанию
Возвращает:: пространство имён с указанным значением

createNamespace

public abstract Namespace createNamespace(String prefix, String namespaceUri)

Создаёт новое пространство имён

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

createStartElement

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

Создаёт новый StartElement. Пространства имён можно добавить в этот StartElement, передав Iterator, перебирающий набор интерфейсов Namespace. Атрибуты можно добавить в этот StartElement, передав итератор, перебирающий набор интерфейсов 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. При запросе пространств имён или атрибутов этого события будет возвращён пустой итератор.

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

createStartElement

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

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

createStartElement

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

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

createEndElement

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

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

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

createEndElement

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

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

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

createEndElement

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

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

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

createCharacters

public abstract Characters createCharacters(String content)

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

Параметры:: content - создаваемая строка
Возвращает:: событие Characters

createCData

public abstract Characters createCData(String content)

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

Параметры:: content - создаваемая строка
Возвращает:: событие Characters

createSpace

public abstract Characters createSpace(String content)

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

Параметры:: content - содержимое создаваемого пробела
Возвращает:: событие Characters

createIgnorableSpace

public abstract Characters createIgnorableSpace(String content)

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

Параметры:: content - создаваемый пробел
Возвращает:: событие Characters

createStartDocument

public abstract StartDocument createStartDocument()

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

Возвращает:: событие StartDocument

createStartDocument

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

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

Параметры:: encoding - стиль кодировки; version - версия XML; standalone - состояние standalone может иметь значение "true" или "false"
Возвращает:: событие StartDocument

createStartDocument

public abstract StartDocument createStartDocument(String encoding, String version)

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

Параметры:: encoding - стиль кодировки; version - версия XML
Возвращает:: событие StartDocument

createStartDocument

public abstract StartDocument createStartDocument(String encoding)

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

Параметры:: encoding - стиль кодировки
Возвращает:: событие StartDocument

createEndDocument

public abstract EndDocument createEndDocument()

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

Возвращает:: событие EndDocument

createEntityReference

public abstract EntityReference createEntityReference(String name, EntityDeclaration declaration)

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

Параметры:: name - имя ссылки; declaration - объявление для события
Возвращает:: событие EntityReference

createComment

public abstract Comment createComment(String text)

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

Параметры:: text - текст комментария
Возвращает:: событие Comment

createProcessingInstruction

public abstract ProcessingInstruction createProcessingInstruction(String target, String data)

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

Параметры:: target - цель инструкции обработки; data - текст инструкции обработки
Возвращает:: событие ProcessingInstruction

createDTD

public abstract DTD createDTD(String dtd)

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

Параметры:: dtd - текст определения типа документа
Возвращает:: событие DTD

© 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.