Spec-Zone.ru › OpenJDK 21

Класс XMLInputFactory

java.lang.Object
javax.xml.stream.XMLInputFactory
public abstract class XMLInputFactory extends Object
Определяет абстрактную реализацию фабрики для получения потоков. В следующей таблице определены стандартные свойства этого спецификации. Каждое свойство варьируется в зависимости от уровня поддержки, требуемого каждой реализацией. Уровень требуемой поддержки описан в столбце 'Требуется'.
Параметры конфигурации
Имя свойства Поведение Тип возвращаемого значения Значение по умолчанию Требуется
javax.xml.stream.isValidating Включает/выключает проверку DTD, специфичную для реализации Boolean False Нет
javax.xml.stream.isNamespaceAware Включает/выключает обработку имен пространств имён для поддержки XML 1.0 Boolean True True (требуется) / False (необязательно)
javax.xml.stream.isCoalescing Требует от процессора объединения смежных данных символов Boolean False Да
javax.xml.stream.isReplacingEntityReferences Заменять внутренние ссылки на сущности их замещающим текстом и сообщать о них как о символах Boolean True Да
javax.xml.stream.isSupportingExternalEntities Разрешить внешние анализируемые сущности Boolean Не указано Да
javax.xml.stream.supportDTD Используйте это свойство для запроса процессоров, которые не поддерживают DTD Boolean True Да
javax.xml.stream.reporter устанавливает/получает реализацию XMLReporter javax.xml.stream.XMLReporter Null Да
javax.xml.stream.resolver устанавливает/получает реализацию интерфейса XMLResolver javax.xml.stream.XMLResolver Null Да
javax.xml.stream.allocator устанавливает/получает реализацию интерфейса XMLEventAllocator javax.xml.stream.util.XMLEventAllocator Null Да
Since:
1.6
См. также:
  • XMLOutputFactory
  • XMLEventReader
  • XMLStreamReader
  • EventFilter
  • XMLReporter
  • XMLResolver
  • XMLEventAllocator

Краткое описание полей

Модификатор и тип Поле Описание
static final String ALLOCATOR
Свойство, используемое для установки/получения реализации распределятора
static final String IS_COALESCING
Свойство, требующее от анализатора объединять смежные разделы данных символов
static final String IS_NAMESPACE_AWARE
Свойство, используемое для включения/выключения поддержки пространств имен, это необходимо для поддержки документов XML 1.0, должна поддерживаться только установка true
static final String IS_REPLACING_ENTITY_REFERENCES
Требует от анализатора заменять внутренние ссылки на сущности их замещающим текстом и сообщать о них как о символах
static final String IS_SUPPORTING_EXTERNAL_ENTITIES
Свойство, требующее от анализатора разрешать внешние анализируемые сущности
static final String IS_VALIDATING
Свойство, используемое для включения/выключения проверки, специфичной для реализации
static final String REPORTER
Свойство, используемое для установки/получения реализации интерфейса XMLReporter
static final String RESOLVER
Свойство, используемое для установки/получения реализации XMLResolver
static final String SUPPORT_DTD
Свойство, требующее от анализатора поддержки DTD

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

XMLInputFactory()
Модификатор Конструктор Описание
protected
Защищённый конструктор для предотвращения создания экземпляров.

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

Модификатор и тип Метод Описание
abstract XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter)
Создаёт фильтрующий читатель событий, который оборачивает фильтр вокруг читателя событий
abstract XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter)
Создаёт фильтрующий читатель, который оборачивает фильтр вокруг читателя
abstract XMLEventReader createXMLEventReader(InputStream stream)
Создаёт новый XMLEventReader из java.io.InputStream
abstract XMLEventReader createXMLEventReader(InputStream stream, String encoding)
Создаёт новый XMLEventReader из java.io.InputStream
abstract XMLEventReader createXMLEventReader(Reader reader)
Создаёт новый XMLEventReader из потока чтения.
abstract XMLEventReader createXMLEventReader(String systemId, InputStream stream)
Создаёт новый XMLEventReader из java.io.InputStream
abstract XMLEventReader createXMLEventReader(String systemId, Reader reader)
Создаёт новый XMLEventReader из потока чтения.
abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)
Создаёт новый XMLEventReader из XMLStreamReader.
abstract XMLEventReader createXMLEventReader(Source source)
Создаёт новый XMLEventReader из источника JAXP.
abstract XMLStreamReader createXMLStreamReader(InputStream stream)
Создаёт новый XMLStreamReader из java.io.InputStream.
abstract XMLStreamReader createXMLStreamReader(InputStream stream, String encoding)
Создаёт новый XMLStreamReader из java.io.InputStream.
abstract XMLStreamReader createXMLStreamReader(Reader reader)
Создаёт новый XMLStreamReader из потока чтения.
abstract XMLStreamReader createXMLStreamReader(String systemId, InputStream stream)
Создаёт новый XMLStreamReader из java.io.InputStream.
abstract XMLStreamReader createXMLStreamReader(String systemId, Reader reader)
Создаёт новый XMLStreamReader из java.io.InputStream.
abstract XMLStreamReader createXMLStreamReader(Source source)
Создаёт новый XMLStreamReader из источника JAXP.
abstract XMLEventAllocator getEventAllocator()
Получает распределятель, используемый потоками, созданными с помощью этой фабрики
abstract Object getProperty(String name)
Получение значения функции/свойства из базовой реализации
abstract XMLReporter getXMLReporter()
Репортер, который будет установлен для любого XMLStreamReader или XMLEventReader, созданного этим экземпляром фабрики.
abstract XMLResolver getXMLResolver()
Разрешитель, который будет установлен для любого XMLStreamReader или XMLEventReader, созданного этим экземпляром фабрики.
abstract boolean isPropertySupported(String name)
Запрос набора свойств, поддерживаемых этой фабрикой.
static XMLInputFactory newDefaultFactory()
Создаёт новый экземпляр XMLInputFactory встроенной реализации по умолчанию.
static XMLInputFactory newFactory()
Создаёт новый экземпляр фабрики.
static XMLInputFactory newFactory(String factoryId, ClassLoader classLoader)
Создаёт новый экземпляр фабрики.
static XMLInputFactory newInstance()
Создаёт новый экземпляр фабрики точно так же, как и метод newFactory().
static XMLInputFactory newInstance(String factoryId, ClassLoader classLoader)
Устарело.
Этот метод устарел для поддержания согласованности API.
abstract void setEventAllocator(XMLEventAllocator allocator)
Позволяет пользователю установить конкретный распределятель событий для событий
abstract void setProperty(String name, Object value)
Позволяет пользователю установить конкретное свойство/функцию в базовой реализации.
abstract void setXMLReporter(XMLReporter reporter)
Репортер, который будет установлен для любого XMLStreamReader или XMLEventReader, созданного этим экземпляром фабрики.
abstract void setXMLResolver(XMLResolver resolver)
Разрешитель, который будет установлен для любого XMLStreamReader или XMLEventReader, созданного этим экземпляром фабрики.

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

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

Подробное описание полей

IS_NAMESPACE_AWARE

public static final String IS_NAMESPACE_AWARE
Свойство, используемое для включения/выключения поддержки пространств имён. Необходимо для поддержки документов XML 1.0, поддерживается только значение true
См. также:
  • Значения константных полей

IS_VALIDATING

public static final String IS_VALIDATING
Свойство, используемое для включения/выключения реализации специфичной валидации.
См. также:
  • Значения константных полей

IS_COALESCING

public static final String IS_COALESCING
Свойство, требующее от парсера объединять смежные разделы данных символов.
См. также:
  • Значения константных полей

IS_REPLACING_ENTITY_REFERENCES

public static final String IS_REPLACING_ENTITY_REFERENCES
Требует от парсера заменять ссылки на внутренние сущности их замещающим текстом и сообщать о них как о символах.
См. также:
  • Значения константных полей

IS_SUPPORTING_EXTERNAL_ENTITIES

public static final String IS_SUPPORTING_EXTERNAL_ENTITIES
Свойство, требующее от парсера разрешать внешние анализируемые сущности.
См. также:
  • Значения константных полей

SUPPORT_DTD

public static final String SUPPORT_DTD
Свойство, требующее от парсера поддерживать DTD.
См. также:
  • Значения константных полей

REPORTER

public static final String REPORTER
Свойство, используемое для задания/получения реализации интерфейса XMLReporter.
См. также:
  • Значения константных полей

RESOLVER

public static final String RESOLVER
Свойство, используемое для задания/получения реализации XMLResolver.
См. также:
  • Значения константных полей

ALLOCATOR

public static final String ALLOCATOR
Свойство, используемое для задания/получения реализации аллокатора.
См. также:
  • Значения константных полей

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

XMLInputFactory

protected XMLInputFactory()
Защищённый конструктор для предотвращения создания экземпляров. Используйте newFactory() вместо этого.

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

newDefaultFactory

public static XMLInputFactory newDefaultFactory()
Создаёт новый экземпляр XMLInputFactory встроенной реализации по умолчанию.
Возвращает:
Новый экземпляр XMLInputFactory встроенной реализации по умолчанию.
С:
9

newInstance

public static XMLInputFactory newInstance() throws FactoryConfigurationError
Создаёт новый экземпляр фабрики точно так же, как метод newFactory().
Возвращает:
экземпляр XMLInputFactory
Исключения:
FactoryConfigurationError - если экземпляр этой фабрики не может быть загружен

newFactory

public static XMLInputFactory newFactory() throws FactoryConfigurationError
Создаёт новый экземпляр фабрики. Этот метод использует механизм поиска JAXP для определения класса реализации XMLInputFactory для загрузки.

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

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

newInstance

@Deprecated(since="1.7") public static XMLInputFactory newInstance(String factoryId, ClassLoader classLoader) throws FactoryConfigurationError
Устарело.
Этот метод устарел для поддержания согласованности API. Все методы newInstance заменены соответствующими методами newFactory. Замена newFactory(java.lang.String, java.lang.ClassLoader) метода не вносит изменений в поведение.
Создаёт новый экземпляр фабрики.
Параметры:
factoryId - Имя фабрики для поиска, совпадает с именем свойства
classLoader - classLoader для использования
Возвращает:
реализация фабрики
Исключения:
FactoryConfigurationError - если экземпляр этой фабрики не может быть загружен

newFactory

public static XMLInputFactory newFactory(String factoryId, ClassLoader classLoader) throws FactoryConfigurationError
Создаёт новый экземпляр фабрики. Если аргумент classLoader равен null, используется ContextClassLoader.

Этот метод использует следующий упорядоченный процесс поиска для определения класса реализации XMLInputFactory для загрузки:

  • Используйте значение системной переменной, идентифицируемой как factoryId.

  • Используйте значение свойства factoryId в файле конфигурации, по умолчанию jaxp.properties. Если файл существует и свойство factoryId указано в файле, его значение будет использоваться как класс реализации.

  • Если factoryId равно "javax.xml.stream.XMLInputFactory", используйте механизм загрузки поставщиков услуг, определённый классом ServiceLoader, для попытки найти и загрузить реализацию сервиса, используя указанный ClassLoader. Если classLoader равен null, будет применяться механизм загрузки по умолчанию: механизм загрузки поставщиков услуг будет использовать контекстный класс-загрузчик текущей нити для попытки загрузки сервиса. Если контекстный класс-загрузчик равен null, будет использоваться системный класс-загрузчик.

  • В противном случае, генерируется исключение FactoryConfigurationError.

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

Примечание API:
Параметр factoryId, определённый здесь, не соответствует другим JAXP-фабрикам, где первый параметр — полностью квалифицированное имя класса фабрики, которое предоставляет реализацию фабрики.
Параметры:
factoryId - Имя фабрики для поиска, совпадает с именем свойства
classLoader - classLoader для использования
Возвращает:
реализация фабрики
Исключения:
FactoryConfigurationError - в случае ошибки конфигурации сервиса или если реализация недоступна или не может быть создана.
FactoryConfigurationError - если экземпляр этой фабрики не может быть загружен

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(Reader reader) throws XMLStreamException
Создаёт новый XMLStreamReader из ридера.
Параметры:
reader - данные XML для чтения
Возвращает:
экземпляр XMLStreamReader
Исключения:
XMLStreamException - если произошла ошибка

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(Source source) throws XMLStreamException
Создаёт новый XMLStreamReader из источника JAXP. Этот метод необязателен.
Параметры:
source - источник для чтения
Возвращает:
экземпляр XMLStreamReader
Исключения:
UnsupportedOperationException - если этот метод не поддерживается данной XMLInputFactory
XMLStreamException - если произошла ошибка

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(InputStream stream) throws XMLStreamException
Создать новый XMLStreamReader из java.io.InputStream.
Параметры:
stream - входной поток InputStream
Возвращает:
экземпляр XMLStreamReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(InputStream stream, String encoding) throws XMLStreamException
Создать новый XMLStreamReader из java.io.InputStream.
Параметры:
stream - входной поток InputStream
encoding - кодировка символов потока
Возвращает:
экземпляр XMLStreamReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(String systemId, InputStream stream) throws XMLStreamException
Создать новый XMLStreamReader из java.io.InputStream.
Параметры:
systemId - системный идентификатор потока
stream - входной поток InputStream
Возвращает:
экземпляр XMLStreamReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createXMLStreamReader

public abstract XMLStreamReader createXMLStreamReader(String systemId, Reader reader) throws XMLStreamException
Создать новый XMLStreamReader из java.io.InputStream.
Параметры:
systemId - системный идентификатор потока
reader - входной поток InputStream
Возвращает:
экземпляр XMLStreamReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(Reader reader) throws XMLStreamException
Создать новый XMLEventReader из ридера.
Параметры:
reader - XML-данные для чтения
Возвращает:
экземпляр XMLEventReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(String systemId, Reader reader) throws XMLStreamException
Создать новый XMLEventReader из ридера.
Параметры:
systemId - системный идентификатор ввода
reader - XML-данные для чтения
Возвращает:
экземпляр XMLEventReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(XMLStreamReader reader) throws XMLStreamException
Создать новый XMLEventReader из XMLStreamReader. После использования для создания экземпляра XMLEventReader, возвращаемого этим методом, XMLStreamReader больше использовать нельзя.
Параметры:
reader - XMLStreamReader для чтения (не должен изменяться)
Возвращает:
новый XMLEventReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(Source source) throws XMLStreamException
Создать новый XMLEventReader из JAXP источника. Поддержка этого метода является необязательной.
Параметры:
source - источник для чтения
Возвращает:
экземпляр XMLEventReader
Выбрасывает:
XMLStreamException - если произошла ошибка
UnsupportedOperationException - если этот метод не поддерживается этим XMLInputFactory

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(InputStream stream) throws XMLStreamException
Создать новый XMLEventReader из java.io.InputStream
Параметры:
stream - входной поток InputStream
Возвращает:
экземпляр XMLEventReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(InputStream stream, String encoding) throws XMLStreamException
Создать новый XMLEventReader из java.io.InputStream
Параметры:
stream - входной поток InputStream
encoding - кодировка символов потока
Возвращает:
экземпляр XMLEventReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createXMLEventReader

public abstract XMLEventReader createXMLEventReader(String systemId, InputStream stream) throws XMLStreamException
Создать новый XMLEventReader из java.io.InputStream
Параметры:
systemId - системный идентификатор потока
stream - входной поток InputStream
Возвращает:
экземпляр XMLEventReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createFilteredReader

public abstract XMLStreamReader createFilteredReader(XMLStreamReader reader, StreamFilter filter) throws XMLStreamException
Создать фильтрующий ридер, который обертывает фильтр вокруг ридера
Параметры:
reader - ридер для фильтрации
filter - фильтр для применения к ридеру
Возвращает:
экземпляр XMLEventReader
Выбрасывает:
XMLStreamException - если произошла ошибка

createFilteredReader

public abstract XMLEventReader createFilteredReader(XMLEventReader reader, EventFilter filter) throws XMLStreamException
Создать фильтрующий ридер событий, который обертывает фильтр вокруг ридера событий
Параметры:
reader - ридер событий для обёртки
filter - фильтр для применения к ридеру событий
Возвращает:
экземпляр XMLEventReader
Выбрасывает:
XMLStreamException - если произошла ошибка

getXMLResolver

public abstract XMLResolver getXMLResolver()
Резолвер, который будет установлен на любой XMLStreamReader или XMLEventReader, созданный этим экземпляром фабрики.
Возвращает:
экземпляр XMLResolver

setXMLResolver

public abstract void setXMLResolver(XMLResolver resolver)
Резолвер, который будет установлен на любой XMLStreamReader или XMLEventReader, созданный этим экземпляром фабрики.
Параметры:
resolver - резолвер для разрешения ссылок

getXMLReporter

public abstract XMLReporter getXMLReporter()
Репортер, который будет установлен на любой XMLStreamReader или XMLEventReader, созданный этим экземпляром фабрики.
Возвращает:
экземпляр XMLReporter

setXMLReporter

public abstract void setXMLReporter(XMLReporter reporter)
Репортер, который будет установлен на любой XMLStreamReader или XMLEventReader, созданный этим экземпляром фабрики.
Параметры:
reporter - резолвер для отчёта об ошибках, не являющихся фатальными

setProperty

public abstract void setProperty(String name, Object value) throws IllegalArgumentException
Позволяет пользователю задать определённое свойство/функцию на базовой реализации. Базовая реализация не обязана поддерживать каждое свойство в спецификации и может использовать IllegalArgumentException, чтобы указать, что заданное свойство не может быть установлено со значением.

Все реализации, реализующие JAXP 1.5 или более поздние версии, обязаны поддерживать свойство XMLConstants.ACCESS_EXTERNAL_DTD.

  • Доступ к внешним DTD, внешним ссылкам сущностей ограничен протоколами, определёнными свойством. Если доступ запрещён во время разбора из-за ограничения этого свойства, XMLStreamException будет выброшен методом XMLStreamReader.next() или XMLEventReader.nextEvent().

Параметры:
name - Имя свойства (не может быть null)
value - Значение свойства
Выбрасывает:
IllegalArgumentException - если свойство не поддерживается

getProperty

public abstract Object getProperty(String name) throws IllegalArgumentException
Получить значение свойства/функции из базовой реализации
Параметры:
name - Имя свойства (не может быть null)
Возвращает:
Значение свойства
Выбрасывает:
IllegalArgumentException - если свойство не поддерживается

isPropertySupported

public abstract boolean isPropertySupported(String name)
Запросить набор свойств, поддерживаемых этой фабрикой.
Параметры:
name - Имя свойства (не может быть null)
Возвращает:
true, если свойство поддерживается, и false в противном случае

setEventAllocator

public abstract void setEventAllocator(XMLEventAllocator allocator)
Установить пользовательский распределитель событий для событий
Параметры:
allocator - пользовательский распределитель

getEventAllocator

public abstract XMLEventAllocator getEventAllocator()
Получить распределитель, используемый потоками, созданными с помощью этой фабрики
Возвращает:
экземпляр XMLEventAllocator

© 1993, 2023, 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/21/docs/api/java.xml/javax/xml/stream/XMLInputFactory.html

Spec-Zone.ru

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