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

Конструкторы

Модификатор Конструктор Описание
protected DocumentBuilder()

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

Методы

Модификатор и тип Метод Описание
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
См. также:
DocumentHandler

parse

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

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

Параметры:
is - Поток ввода, содержащий содержимое для обработки.
systemId - Предоставляет основу для разрешения относительных URI.
Возвращает:
Новый объект DOM Document.
Исключение:
IOException - При возникновении ошибок ввода-вывода.
SAXException - При возникновении ошибок разбора.
IllegalArgumentException - Когда is равно null
См. также:
DocumentHandler

parse

public Document parse(String uri)
               throws SAXException,
                      IOException

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

Параметры:
uri - Местоположение содержимого для обработки.
Возвращает:
Новый объект DOM Document.
Исключение:
IOException - При возникновении ошибок ввода-вывода.
SAXException - При возникновении ошибок разбора.
IllegalArgumentException - Когда uri равно null
См. также:
DocumentHandler

parse

public Document parse(File f)
               throws SAXException,
                      IOException

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

Параметры:
f - Файл, содержащий XML для обработки.
Возвращает:
Новый объект DOM Document.
Исключение:
IOException - При возникновении ошибок ввода-вывода.
SAXException - При возникновении ошибок разбора.
IllegalArgumentException - Когда f равно null
См. также:
DocumentHandler

parse

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

Обработать содержимое указанного источника ввода как XML-документ и вернуть новый объект DOM Document. Бросается IllegalArgumentException , если InputSource равно null 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, если этот парсер настроен на проверку 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
См. также:
DocumentBuilderFactory.setXIncludeAware(boolean)

© 1993, 2020, 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/11/docs/api/java.xml/javax/xml/parsers/DocumentBuilder.html

Spec-Zone .ru
спецификации, руководства, описания, API