Класс DocumentBuilder

java.lang.Object

javax.xml.parsers.DocumentBuilder

public abstract class DocumentBuilder extends Object

Определяет API для получения экземпляров DOM Document из XML-документа. С помощью этого класса программист может получить Document из XML.

Экземпляр этого класса можно получить с помощью метода DocumentBuilderFactory.newDocumentBuilder(). После получения экземпляра этого класса XML можно анализировать из различных источников ввода. Эти источники ввода представляют собой InputStream, файлы, URL-адреса и SAX InputSources.

Обратите внимание, что этот класс использует несколько классов из API SAX. Это не требует, чтобы реализатор базовой реализации DOM использовал парсер SAX для разбора XML-документа в Document. Это просто требует, чтобы реализация взаимодействовала с приложением с использованием этих существующих API.

Since:: 1.4

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

DocumentBuilder()

Модификатор	Конструктор	Описание
`protected`	Защищённый конструктор

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

Модификатор и тип	Метод	Описание
`abstract DOMImplementation`	`getDOMImplementation()`	Получение экземпляра объекта `DOMImplementation`.
`Schema`	`getSchema()`	Получение ссылки на используемую `Schema` обработчиком XML.
`abstract boolean`	`isNamespaceAware()`	Указывает, настроен ли этот парсер для понимания имен пространств имён.
`abstract boolean`	`isValidating()`	Указывает, настроен ли этот парсер для валидации XML-документов.
`boolean`	`isXIncludeAware()`	Получение режима обработки XInclude для этого парсера.
`abstract Document`	`newDocument()`	Получение нового экземпляра объекта DOM `Document` для построения дерева DOM.
`Document`	`parse(File f)`	Разбор содержимого данного файла как XML-документа и возврат нового объекта DOM `Document`.
`Document`	`parse(InputStream is)`	Разбор содержимого данного `InputStream` как XML-документа и возврат нового объекта DOM `Document`.
`Document`	`parse(InputStream is, String systemId)`	Разбор содержимого данного `InputStream` как XML-документа и возврат нового объекта DOM `Document`.
`Document`	`parse(String uri)`	Разбор содержимого данного URI как XML-документа и возврат нового объекта DOM `Document`.
`abstract Document`	`parse(InputSource is)`	Разбор содержимого данного источника ввода как XML-документа и возврат нового объекта DOM `Document`.
`void`	`reset()`	Сброс настроек этого `DocumentBuilder` до исходных значений.
`abstract void`	`setEntityResolver(EntityResolver er)`	Указание `EntityResolver` для разрешения сущностей, присутствующих в XML-документе, подлежащем разбору.
`abstract void`	`setErrorHandler(ErrorHandler eh)`	Указание `ErrorHandler` для использования парсером.

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

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

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

DocumentBuilder

protected DocumentBuilder()

Защищённый конструктор

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

reset

public void reset()

Сбросить текущий DocumentBuilder до его исходной конфигурации.

DocumentBuilder сбрасывается в такое же состояние, как при создании с помощью DocumentBuilderFactory.newDocumentBuilder(). reset() предназначен для повторного использования существующих DocumentBuilder для экономии ресурсов, связанных с созданием новых DocumentBuilder.

Сброшенное состояние DocumentBuilder не гарантирует одинаковый EntityResolver или ErrorHandler Object (например, Object.equals(Object obj)). Гарантируется функциональное равенство EntityResolver и ErrorHandler.

Возбуждает:: UnsupportedOperationException - Когда реализация не переопределяет этот метод.
С:: 1.5

parse

public Document parse(InputStream is) throws SAXException, IOException

Обработать содержимое заданного InputStream как XML-документ и вернуть новый объект DOM Document. Если IllegalArgumentException равен null, будет возбуждено исключение.

Параметры:

is - Поток ввода, содержащий данные для обработки.

Возвращает:

Document результат обработки InputStream

Возбуждает:

IOException - Если произошла ошибка ввода-вывода.

SAXException - Если произошла ошибка обработки.

IllegalArgumentException - Когда is равен null

См. также:

DocumentHandler

parse

public Document parse(InputStream is, String systemId) throws SAXException, IOException

Параметры:

is - Поток ввода, содержащий данные для обработки.

systemId - Базовая ссылка для разрешения относительных URI.

Возвращает:

Новый объект DOM Document.

Возбуждает:

IOException - Если произошла ошибка ввода-вывода.

SAXException - Если произошла ошибка обработки.

IllegalArgumentException - Когда is равен null

См. также:

DocumentHandler

parse

public Document parse(String uri) throws SAXException, IOException

Обработать содержимое заданного URI как XML-документ и вернуть новый объект DOM Document. Если URI равен null, будет возбуждено исключение.

Параметры:

uri - Расположение обрабатываемых данных.

Возвращает:

Новый объект DOM Document.

Возбуждает:

IOException - Если произошла ошибка ввода-вывода.

SAXException - Если произошла ошибка обработки.

IllegalArgumentException - Когда uri равен null

См. также:

DocumentHandler

parse

public Document parse(File f) throws SAXException, IOException

Обработать содержимое заданного файла как XML-документ и вернуть новый объект DOM Document. Если файл равен null, будет возбуждено исключение.

Параметры:

f - Файл, содержащий XML для обработки.

Возвращает:

Новый объект DOM Document.

Возбуждает:

IOException - Если произошла ошибка ввода-вывода.

SAXException - Если произошла ошибка обработки.

IllegalArgumentException - Когда f равен null

См. также:

DocumentHandler

parse

public abstract Document parse(InputSource is) throws SAXException, IOException

Обработать содержимое заданного источника ввода как XML-документ и вернуть новый объект DOM Document. Если источник ввода равен null, будет возбуждено исключение.

Параметры:

is - InputSource, содержащий данные для обработки.

Возвращает:

Новый объект DOM Document.

Возбуждает:

IOException - Если произошла ошибка ввода-вывода.

SAXException - Если произошла ошибка обработки.

IllegalArgumentException - Когда is равен null

См. также:

DocumentHandler

isNamespaceAware

public abstract boolean isNamespaceAware()

Указывает, поддерживает ли этот анализатор пространства имён.

Возвращает:: true, если анализатор поддерживает пространства имён; иначе false.

isValidating

public abstract boolean isValidating()

Указывает, включена ли валидация XML-документов в этом анализаторе.

Возвращает:: true, если валидация включена; иначе false.

setEntityResolver

public abstract void setEntityResolver(EntityResolver er)

Указывает EntityResolver для разрешения сущностей в обрабатываемом XML-документе. Установка значения null приводит к использованию реализации по умолчанию.

Параметры:: er - EntityResolver для разрешения сущностей.

setErrorHandler

public abstract void setErrorHandler(ErrorHandler eh)

Указывает ErrorHandler для использования анализатором. Установка значения null использует реализацию по умолчанию.

Параметры:: eh - ErrorHandler для использования анализатором.

newDocument

public abstract Document newDocument()

Получить новый экземпляр объекта DOM Document для построения дерева DOM.

Возвращает:: Новый экземпляр объекта DOM Document.

getDOMImplementation

public abstract DOMImplementation getDOMImplementation()

Получить экземпляр объекта DOMImplementation.

Возвращает:: Новый экземпляр DOMImplementation.

getSchema

public Schema getSchema()

Получить ссылку на используемую Schema обработчиком XML.

Если схема не используется, возвращается null.

Возвращает:: Schema или null (если схема не используется)
Возбуждает:: UnsupportedOperationException - Когда реализация не переопределяет этот метод
С:: 1.5

isXIncludeAware

public boolean isXIncludeAware()

Получить режим обработки XInclude для данного анализатора.

Возвращает:

значение DocumentBuilderFactory.isXIncludeAware() при создании анализатора из фабрики.

Возбуждает:

UnsupportedOperationException - Когда реализация не переопределяет этот метод

С:

1.5

См. также:

DocumentBuilderFactory.setXIncludeAware(boolean)

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