Spec-Zone.ru › OpenJDK 24

Класс XMLEventFactory

java.lang.Object
javax.xml.stream.XMLEventFactory
public abstract class XMLEventFactory extends Object
Этот интерфейс определяет вспомогательный класс для создания экземпляров XMLEvents
С момента:
1.6
См. также:
  • StartElement
  • EndElement
  • ProcessingInstruction
  • Comment
  • Characters
  • StartDocument
  • EndDocument
  • DTD

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

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

Методы, объявленные в классе 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 - Используемый класс загрузчик
Возвращает:
реализация фабрики
Исключение:
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)
Этот метод позволяет установить местоположение для каждого события, созданного этой фабрикой. Значения копируются по значению в события, созданные этой фабрикой. Для сброса информации о местоположении установите местоположение в 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 путём передачи итератора, который проходит по набору интерфейсов 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)
Создать новый StartElement. Пространства имён можно добавить в этот StartElement, передав итератор, который проходит по набору интерфейсов Namespace. Атрибуты можно добавить в этот StartElement, передав итератор, который проходит по набору интерфейсов Attribute.
Parameters:
prefix - префикс QName нового StartElement
namespaceUri - uri QName нового StartElement
localName - локальное имя 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)
Создать новый StartElement. Пространства имён можно добавить в этот StartElement, передав итератор, который проходит по набору интерфейсов Namespace. Атрибуты можно добавить в этот StartElement, передав итератор, который проходит по набору интерфейсов Attribute.
Parameters:
prefix - префикс QName нового StartElement
namespaceUri - uri QName нового StartElement
localName - локальное имя 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:
prefix - префикс QName нового StartElement
namespaceUri - uri QName нового StartElement
localName - локальное имя QName нового StartElement
Returns:
экземпляр запрошенного EndElement

createEndElement

public abstract EndElement createEndElement(String prefix, String namespaceUri, String localName, Iterator<? extends Namespace> namespaces)
Создать новый EndElement
Parameters:
prefix - префикс QName нового StartElement
namespaceUri - uri QName нового StartElement
localName - локальное имя QName нового StartElement
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 - состояние 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, 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/stream/XMLEventFactory.html

Spec-Zone.ru

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