Класс DocumentBuilder

java.lang.Object

javax.xml.parsers.DocumentBuilder

public abstract class DocumentBuilder extends Object

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

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

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

Начиная с:: 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`, который будет использоваться парсером.

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

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

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

DocumentBuilder

protected DocumentBuilder()

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

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

reset

public void reset()

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

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

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

Вызывает исключение:: UnsupportedOperationException — если реализация не переопределяет этот метод.
Начиная с:: 1.5

parse

public Document parse(InputStream is) throws SAXException, IOException

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

Параметры:

is — InputStream, содержащий анализируемое содержимое.

Возвращает:

Document результат анализа InputStream

Вызывает исключение:

IOException — при возникновении ошибок ввода-вывода.

SAXException — при возникновении ошибок анализа.

IllegalArgumentException — если is имеет значение null

См. также:

parse

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

Параметры:

is — InputStream, содержащий анализируемое содержимое.

systemId — задаёт базовый URI для разрешения относительных URI.

Возвращает:

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

Вызывает исключение:

IOException — при возникновении ошибок ввода-вывода.

SAXException — при возникновении ошибок анализа.

IllegalArgumentException — если is имеет значение null

См. также:

parse

public Document parse(String uri) throws SAXException, IOException

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

Параметры:

uri — расположение анализируемого содержимого.

Возвращает:

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

Вызывает исключение:

IOException — при возникновении ошибок ввода-вывода.

SAXException — при возникновении ошибок анализа.

IllegalArgumentException — если uri имеет значение null

См. также:

parse

public Document parse(File f) throws SAXException, IOException

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

Параметры:

f — файл, содержащий анализируемый XML.

Возвращает:

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

Вызывает исключение:

IOException — при возникновении ошибок ввода-вывода.

SAXException — при возникновении ошибок анализа.

IllegalArgumentException — если f имеет значение null

См. также:

parse

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

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

Параметры:

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://docs.oracle.com/en/java/javase/25/docs/api/java.xml/javax/xml/parsers/DocumentBuilder.html