Spec-Zone.ru › OpenJDK 8

Класс XMLEventFactory

  • java.lang.Object
    • javax.xml.stream.XMLEventFactory

public abstract class XMLEventFactory
extends Object

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

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

Конструкторы

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

Методы

Модификатор и тип Метод и описание
abstract Attribute createAttribute(QName name, String value)

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

abstract Attribute createAttribute(String localName, String value)

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

abstract Attribute createAttribute(String prefix, String namespaceURI, String localName, 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(QName name, Iterator namespaces)

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

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

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

abstract EndElement createEndElement(String prefix, String namespaceUri, String localName, Iterator 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(QName name, Iterator attributes, Iterator namespaces)

Создать новый StartElement.

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

Создать новый StartElement.

abstract StartElement createStartElement(String prefix, String namespaceUri, String localName, Iterator attributes, Iterator namespaces)

Создать новый StartElement.

abstract StartElement createStartElement(String prefix, String namespaceUri, String localName, Iterator attributes, Iterator namespaces, NamespaceContext context)

Создать новый StartElement.

static XMLEventFactory newFactory()

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

static XMLEventFactory newFactory(String factoryId, ClassLoader classLoader)

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

static XMLEventFactory newInstance()

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

static XMLEventFactory newInstance(String factoryId, ClassLoader classLoader)

Устарело.

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

abstract void setLocation(Location location)

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

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

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

Конструкторы

XMLEventFactory

protected XMLEventFactory()

Методы

newInstance

public static XMLEventFactory newInstance()
                                   throws FactoryConfigurationError

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

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

newFactory

public static XMLEventFactory newFactory()
                                  throws FactoryConfigurationError

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

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

  • Использует системную переменную javax.xml.stream.XMLEventFactory.
  • Использует файл свойств "lib/stax.properties" в каталоге JRE. Этот конфигурационный файл имеет стандартный формат java.util.Properties и содержит полное имя класса реализации, ключ которого соответствует вышеупомянутой системной переменной.
  • Использует механизмы загрузки поставщиков услуг, определённые классом ServiceLoader, для поиска и загрузки реализации услуги, используя стандартный механизм загрузки: механизм загрузки поставщиков услуг будет использовать контекстный загрузчик класса текущей нити для попытки загрузки услуги. Если контекстный загрузчик равен null, будет использован системный загрузчик классов.
  • В противном случае возвращается системная реализация по умолчанию.

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

Обратите внимание, что это новый метод, который заменяет устаревший метод newInstance(). Данный метод не определяет никаких изменений в поведении по сравнению с устаревшим методом.

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

newInstance

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.
  • Использует файл свойств "lib/stax.properties" в каталоге JRE. Этот конфигурационный файл имеет стандартный формат java.util.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)

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

Spec-Zone.ru

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