Класс 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.

Возбуждает:

IOException - Если возникнут ошибки ввода-вывода.

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

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

См. также:

parse

public Document parse(String uri) throws SAXException, IOException

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

Параметры:

uri - Расположение содержимого для анализа.

Возвращает:

Новый объект документа DOM.

Возбуждает:

IOException - Если возникнут ошибки ввода-вывода.

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

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

См. также:

parse

public Document parse(File f) throws SAXException, IOException

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

Параметры:

f - Файл, содержащий XML для анализа.

Возвращает:

Новый объект документа DOM.

Возбуждает:

IOException - Если возникнут ошибки ввода-вывода.

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

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

См. также:

parse

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

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

Параметры:

is - InputSource, содержащий содержимое для анализа.

Возвращает:

Новый объект документа DOM.

Возбуждает:

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.

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, 2023, 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/21/docs/api/java.xml/javax/xml/parsers/DocumentBuilder.html