Класс DocumentBuilder

java.lang.Object

javax.xml.parsers.DocumentBuilder

public abstract class DocumentBuilder extends Object

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

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

Обратите внимание, что в этом классе повторно используются несколько классов из API SAX. Это не означает, что реализация базовой реализации 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

Модификатор и тип	Метод	Описание
`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, либо до истечения заданного периода времени.

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

DocumentBuilder

protected DocumentBuilder()

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

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

reset

public void reset()

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

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

После сброса DocumentBuilder не гарантируется наличие тех же Object 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.