Spec-Zone.ru › OpenJDK 8

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

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

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

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

Методы

Модификатор и тип Метод и описание
abstract DOMImplementation getDOMImplementation()

Получить экземпляр объекта DOMImplementation.

Schema getSchema()

Получить ссылку на используемую обработчиком XML схему Schema.

abstract boolean isNamespaceAware()

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

abstract boolean isValidating()

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

boolean isXIncludeAware()

Получить режим обработки XInclude для этого парсера.

abstract Document newDocument()

Получить новый экземпляр объекта DOM Document для построения дерева DOM.

Document parse(File f)

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

abstract Document parse(InputSource is)

Обработать содержимое данного источника ввода как 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.

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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API