Класс DefaultHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

Все реализованные интерфейсы:: ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Прямые известные подклассы:: DefaultHandler2

public class DefaultHandler extends Object implements EntityResolver, DTDHandler, ContentHandler, ErrorHandler

Базовый класс по умолчанию для обработчиков событий SAX2.

Этот класс доступен как удобный базовый класс для приложений SAX2: он предоставляет реализации по умолчанию для всех обратных вызовов в четырех основных классах обработчиков SAX2:

Разработчики приложений могут расширять этот класс, когда им нужно реализовать только часть интерфейса; разработчики парсеров могут создать экземпляр этого класса для предоставления обработчиков по умолчанию, когда приложение не предоставило собственные.

Этот класс заменяет устаревший класс SAX1 HandlerBase.

С:

1.4, SAX 2.0

См. также:

Краткое описание конструкторов

Конструктор	Описание
`DefaultHandler()`	Создает `DefaultHandler`.

Краткое описание методов

Модификатор и тип	Метод	Описание
`void`	`characters(char[] ch, int start, int length)`	Получение уведомления о символьных данных внутри элемента.
`void`	`endDocument()`	Получение уведомления об окончании документа.
`void`	`endElement(String uri, String localName, String qName)`	Получение уведомления об окончании элемента.
`void`	`endPrefixMapping(String prefix)`	Получение уведомления об окончании отображения пространства имен.
`void`	`error(SAXParseException e)`	Получение уведомления о восстановимом ошибке парсера.
`void`	`fatalError(SAXParseException e)`	Отчет о фатальной ошибке парсинга XML.
`void`	`ignorableWhitespace(char[] ch, int start, int length)`	Получение уведомления о пропускаемом разделителе пробелов внутри содержимого элемента.
`void`	`notationDecl(String name, String publicId, String systemId)`	Получение уведомления о декларации обозначения.
`void`	`processingInstruction(String target, String data)`	Получение уведомления о инструкции обработки.
`InputSource`	`resolveEntity(String publicId, String systemId)`	Разрешение внешней сущности.
`void`	`setDocumentLocator(Locator locator)`	Получение объекта Locator для событий документа.
`void`	`skippedEntity(String name)`	Получение уведомления о пропущенной сущности.
`void`	`startDocument()`	Получение уведомления о начале документа.
`void`	`startElement(String uri, String localName, String qName, Attributes attributes)`	Получение уведомления о начале элемента.
`void`	`startPrefixMapping(String prefix, String uri)`	Получение уведомления о начале отображения пространства имен.
`void`	`unparsedEntityDecl(String name, String publicId, String systemId, String notationName)`	Получение уведомления о декларации необработанной сущности.
`void`	`warning(SAXParseException e)`	Получение уведомления об ошибке парсера.

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

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

Методы, объявленные в интерфейсе org.xml.sax.ContentHandler

declaration

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

DefaultHandler

public DefaultHandler()

Создаёт DefaultHandler.

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

resolveEntity

public InputSource resolveEntity(String publicId, String systemId) throws IOException, SAXException

Разрешает внешнюю сущность.

Всегда возвращает null, чтобы парсер использовал идентификатор системы, указанный в XML-документе. Этот метод реализует стандартное поведение SAX: разработчики приложений могут переопределить его в подклассе для выполнения специальных преобразований, таких как поиск в каталоге или перенаправление URI.

Указано в:

resolveEntity в интерфейсе EntityResolver

Параметры:

publicId - Публичный идентификатор или null, если он недоступен.

systemId - Идентификатор системы, указанный в XML-документе.

Возвращает:

Новый источник ввода или null, чтобы использовать стандартное поведение.

Исключения:

IOException - Если при настройке нового источника ввода произошла ошибка.

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

notationDecl

public void notationDecl(String name, String publicId, String systemId) throws SAXException

Получает уведомление о объявлении нотации.

По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе, если хотят отслеживать нотации, объявленные в документе.

Указано в:

notationDecl в интерфейсе DTDHandler

Параметры:

name - Имя нотации.

publicId - Публичный идентификатор нотации или null, если он недоступен.

systemId - Идентификатор системы нотации.

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

unparsedEntityDecl

public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException

Получает уведомление об объявлении необработанной сущности.

По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе, чтобы отслеживать необработанные сущности, объявленные в документе.

Указано в:

unparsedEntityDecl в интерфейсе DTDHandler

Параметры:

name - Имя сущности.

publicId - Публичный идентификатор сущности или null, если он недоступен.

systemId - Идентификатор системы сущности.

notationName - Имя связанной нотации.

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

setDocumentLocator

public void setDocumentLocator(Locator locator)

Получает объект Locator для событий документа.

По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе, если хотят сохранить локатор для использования с другими событиями документа.

Указано в:

setDocumentLocator в интерфейсе ContentHandler

Параметры:

locator - Локатор для всех событий документа SAX.

См. также:

startDocument

public void startDocument() throws SAXException

Получает уведомление о начале документа.

По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определённых действий в начале документа (например, выделения корневого узла дерева или создания выходного файла).

Указано в:

startDocument в интерфейсе ContentHandler

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

endDocument

public void endDocument() throws SAXException

Получает уведомление о конце документа.

По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определённых действий в конце документа (например, завершения обработки дерева или закрытия выходного файла).

Указано в:

endDocument в интерфейсе ContentHandler

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

startPrefixMapping

public void startPrefixMapping(String prefix, String uri) throws SAXException

Получает уведомление о начале сопоставления имён пространств имён.

По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определённых действий в начале каждого диапазона префиксов имён пространств имён (например, для хранения сопоставления префиксов).

Указано в:

startPrefixMapping в интерфейсе ContentHandler

Параметры:

prefix - Префикс имени пространства имён, который объявляется.

uri - URI имени пространства имён, сопоставленный с префиксом.

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

endPrefixMapping

public void endPrefixMapping(String prefix) throws SAXException

Получает уведомление об окончании сопоставления имён пространств имён.

По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определённых действий в конце каждого сопоставления префиксов.

Указано в:

endPrefixMapping в интерфейсе ContentHandler

Параметры:

prefix - Префикс имени пространства имён, который объявляется.

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

startElement

public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException

Получает уведомление о начале элемента.

По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определённых действий в начале каждого элемента (например, выделения нового узла дерева или записи выходных данных в файл).

Указано в:

startElement в интерфейсе ContentHandler

Параметры:

uri - URI пространства имён или пустая строка, если у элемента нет URI пространства имён или если обработка пространства имён не выполняется.

localName - Локальное имя (без префикса) или пустая строка, если обработка пространства имён не выполняется.

qName - Полное имя (с префиксом) или пустая строка, если полные имена недоступны.

attributes - Атрибуты, присоединённые к элементу. Если атрибутов нет, это объект Attributes, не содержащий атрибутов.

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

endElement

public void endElement(String uri, String localName, String qName) throws SAXException

Получает уведомление об окончании элемента.

По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определённых действий в конце каждого элемента (например, завершения обработки узла дерева или записи выходных данных в файл).

Указано в:

endElement в интерфейсе ContentHandler

Параметры:

localName - Локальное имя (без префикса) или пустая строка, если обработка пространства имён не выполняется.

qName - Полное имя (с префиксом) или пустая строка, если полные имена недоступны.

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

Символы

public void characters(char[] ch, int start, int length) throws SAXException

Получить уведомление о данных символов внутри элемента.

По умолчанию, ничего не делать. Разработчики приложений могут переопределить этот метод, чтобы выполнить определенные действия для каждого фрагмента данных символов (например, добавление данных в узел или буфер, или печать в файл).

Определено в:

characters в интерфейсе ContentHandler

Параметры:

ch - Символы.

start - Начальная позиция в массиве символов.

length - Количество символов для использования из массива символов.

Выбрасывает:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

Пропускаемые пробелы

public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException

Получить уведомление о пропускаемых пробелах в содержимом элемента.

По умолчанию, ничего не делать. Разработчики приложений могут переопределить этот метод, чтобы выполнить определенные действия для каждого фрагмента пропускаемых пробелов (например, добавить данные в узел или буфер, или напечатать в файл).

Определено в:

ignorableWhitespace в интерфейсе ContentHandler

Параметры:

ch - Символы пробелов.

start - Начальная позиция в массиве символов.

length - Количество символов для использования из массива символов.

Выбрасывает:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

Обработка инструкции

public void processingInstruction(String target, String data) throws SAXException

Получить уведомление об инструкции обработки.

По умолчанию, ничего не делать. Разработчики приложений могут переопределить этот метод в подклассе, чтобы выполнить определенные действия для каждой инструкции обработки, такие как установка переменных состояния или вызов других методов.

Определено в:

processingInstruction в интерфейсе ContentHandler

Параметры:

target - Цель инструкции обработки.

data - Данные инструкции обработки или null, если они не предоставлены.

Выбрасывает:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

Пропущенный сущность

public void skippedEntity(String name) throws SAXException

Получить уведомление о пропущенной сущности.

Определено в:

skippedEntity в интерфейсе ContentHandler

Параметры:

name - Название пропущенной сущности.

Выбрасывает:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

Предупреждение

public void warning(SAXParseException e) throws SAXException

Получить уведомление о предупреждении парсера.

По умолчанию, ничего не делать. Разработчики приложений могут переопределить этот метод в подклассе, чтобы выполнить определенные действия для каждого предупреждения, например, вставить сообщение в файл журнала или напечатать его в консоль.

Определено в:

warning в интерфейсе ErrorHandler

Параметры:

e - Информация о предупреждении, закодированная как исключение.

Выбрасывает:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

Ошибка

public void error(SAXParseException e) throws SAXException

Получить уведомление об исправимой ошибке парсера.

По умолчанию, ничего не делать. Разработчики приложений могут переопределить этот метод в подклассе, чтобы выполнить определенные действия для каждой ошибки, например, вставить сообщение в файл журнала или напечатать его в консоль.

Определено в:

error в интерфейсе ErrorHandler

Параметры:

e - Информация об ошибке, закодированная как исключение.

Выбрасывает:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

Критическая ошибка

public void fatalError(SAXParseException e) throws SAXException

Сообщить о фатальной ошибке разбора XML.

По умолчанию, выбрасывается SAXParseException. Разработчики приложений могут переопределить этот метод в подклассе, если им нужно выполнить определенные действия для каждой фатальной ошибки (например, собрать все ошибки в один отчет): в любом случае приложение должно остановить всю обычную обработку при вызове этого метода, так как документ больше не надежен, и парсер может больше не сообщать события разбора.

Определено в:

fatalError в интерфейсе ErrorHandler

Параметры:

e - Информация об ошибке, закодированная как исключение.

Выбрасывает:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

См. также:

© 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/org/xml/sax/helpers/DefaultHandler.html