Класс 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, если InputStream равно null.

Параметры:

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

Возвращает:

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

Выбрасывает:

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

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

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

См. также:

parse

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

Параметры:

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

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

Возвращает:

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

Выбрасывает:

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

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

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

См. также:

parse

public Document parse(String uri) throws SAXException, IOException

Обработайте содержимое заданного URI как XML-документ и верните новый объект DOM Document. Будет выброшено IllegalArgumentException, если URI является null.

Параметры:

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

Возвращает:

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

Выбрасывает:

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

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

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

См. также:

parse

public Document parse(File f) throws SAXException, IOException

Обработайте содержимое данного файла как XML-документ и верните новый объект DOM Document. Будет выброшено IllegalArgumentException, если File является null.

Параметры:

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

Возвращает:

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

Выбрасывает:

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

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

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

См. также:

parse

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

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

Параметры:

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

Возвращает:

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

Выбрасывает:

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

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

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

См. также:

isNamespaceAware

public abstract boolean isNamespaceAware()

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

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

isValidating

public abstract boolean isValidating()

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

Возвращает:: true, если этот анализатор настроен для проверки XML-документов; иначе false.

setEntityResolver

public abstract void setEntityResolver(EntityResolver er)

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

Параметры:: er - EntityResolver для разрешения сущностей, присутствующих в XML-документе, который будет обработан.

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

См. также:

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