Spec-Zone.ru › OpenJDK 27

Класс 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 Да
С версии:
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, созданного этим экземпляром фабрики.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Модификатор и тип Метод Описание
protected Object clone()
Создаёт и возвращает копию этого объекта.
boolean equals(Object obj)
Указывает, равен ли этот объект какому-либо другому объекту.
protected void finalize()
Устарел, будет удалён: этот элемент API может быть удалён в будущей версии.
Финализация устарела и может быть удалена в одном из следующих выпусков.
final Class<?> getClass()
Возвращает класс времени выполнения этого Object.
int hashCode()
Возвращает хеш-код этого объекта.
final void notify()
Пробуждает один поток, ожидающий на мониторе этого объекта.
final void notifyAll()
Пробуждает все потоки, ожидающие на мониторе этого объекта.
String toString()
Возвращает строковое представление объекта.
final void wait()
Приостанавливает текущий поток до его пробуждения, обычно посредством вызова notify или interrupt.
final void wait(long timeoutMillis)
Приостанавливает текущий поток до его пробуждения, обычно посредством вызова notify или interrupt, либо до истечения определённого промежутка времени.
final void wait(long timeoutMillis, int nanos)
Приостанавливает текущий поток до его пробуждения, обычно посредством вызова notify или interrupt, либо до истечения определённого промежутка времени.

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

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 — используемый загрузчик классов
Возвращает:
реализацию фабрики
Выбрасывает:
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 — используемый загрузчик классов
Возвращает:
реализацию фабрики
Выбрасывает:
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. После использования 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 и внешним ссылкам на сущности ограничивается протоколами, указанными в свойстве. Если при синтаксическом анализе доступ запрещён из-за ограничения, заданного этим свойством, метод XMLStreamReader.next() или XMLEventReader.nextEvent() выбрасывает XMLStreamException.

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

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в разделе документации Java SE, содержащем более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторские права © 1993, 2026, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 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.

Spec-Zone.ru

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