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

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

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 — используемый 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 — используемый 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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.xml/javax/xml/stream/XMLEventFactory.html