Класс XMLEventFactory

public abstract class XMLEventFactory
extends Object

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

С:
1.6
См. также:
StartElement, EndElement, ProcessingInstruction, Comment, Characters, StartDocument, EndDocument, DTD

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

Модификатор Конструктор Описание
protected XMLEventFactory()

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

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

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

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

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

XMLEventFactory

protected XMLEventFactory()

Методы

newDefaultFactory

public static XMLEventFactory newDefaultFactory()

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

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

newInstance

public static XMLEventFactory newInstance()
                                   throws FactoryConfigurationError

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

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

newFactory

public static XMLEventFactory newFactory()
                                  throws FactoryConfigurationError

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

Этот статический метод создаёт новый экземпляр фабрики. Этот метод использует следующий упорядоченный процесс поиска для определения класса реализации XMLEventFactory для загрузки:

  • Использует системное свойство javax.xml.stream.XMLEventFactory.

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

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

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

  • Использует механизм загрузки поставщиков услуг, определённый классом ServiceLoader, для попытки поиска и загрузки реализации сервиса с помощью механизма загрузки по умолчанию: механизм загрузки поставщиков услуг будет использовать класс загрузчика текущей нити для попытки загрузки сервиса. Если загрузчик контекста равен null, будет использован системный загрузчик классов.

  • В противном случае возвращается реализация по умолчанию системы (system-default).

После того, как приложение получило ссылку на 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.

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

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

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

setLocation

public abstract void setLocation(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 со значением, указанным выше

createNamespace

public abstract Namespace createNamespace(String prefix,
                                          String namespaceUri)

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

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

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. Запрос этого события для его пространств имён или атрибутов вернёт пустой итератор.

Параметры:
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.

Параметры:
namespaceUri - uri QName нового StartElement
localName - локальное имя QName нового StartElement
prefix - префикс 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)

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

Параметры:
namespaceUri - uri QName нового StartElement
localName - локальное имя QName нового StartElement
prefix - префикс 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

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

createEndElement

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

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

Параметры:
namespaceUri - uri QName нового StartElement
localName - локальное имя QName нового StartElement
prefix - префикс 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, 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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/javax/xml/stream/XMLEventFactory.html

Spec-Zone .ru
спецификации, руководства, описания, API