Spec-Zone.ru › OpenJDK 17

Класс 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 Да (требуется) / Нет (необязательно)
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, только истинное значение должно поддерживаться
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.

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

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

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

  • Если 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 в противном случае

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

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

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

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

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

Spec-Zone.ru

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