Spec-Zone.ru › OpenJDK 24

Класс XMLInputFactory

java.lang.Object
javax.xml.stream.XMLInputFactory
public abstract class XMLInputFactory extends Object
Определяет абстрактную реализацию фабрики для получения потоков. В следующей таблице определены стандартные свойства этого спецификатора. Каждое свойство отличается по уровню поддержки, требуемой каждой реализацией. Уровень требуемой поддержки описан в столбце 'Required'.
Параметры конфигурации
Имя свойства Поведение Тип возвращаемого значения Значение по умолчанию Требуется
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()
Создаёт новый экземпляр встроенной по умолчанию реализации системы.
Возвращает:
Новый экземпляр встроенной по умолчанию реализации системы.
С момента:
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, заданного в файле конфигурации configuration file, по умолчанию 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 - Поток ввода для чтения
Возвращает:
экземпляр 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 - если свойство не поддерживается

Получить свойство

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

Поддерживается свойство

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

Установить распределитель событий

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

Получить распределитель событий

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

© 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/XMLInputFactory.html

Spec-Zone.ru

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