Класс HandlerBase
- java.lang.Object
-
- org.xml.sax.HandlerBase
- Все реализованные интерфейсы:
- DocumentHandler, DTDHandler, EntityResolver, ErrorHandler
Устаревший.
Этот класс работает с устаревшим интерфейсом DocumentHandler. Он был заменён классом SAX2 DefaultHandler.
public class HandlerBase extends Object implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler
Базовый класс по умолчанию для обработчиков.
Этот модуль, как исходный код, так и документация, находится в общественном достоянии и не имеет ГАРАНТИИ. Подробнее см. http://www.saxproject.org.
Этот класс реализует поведение по умолчанию для четырёх интерфейсов SAX1: EntityResolver, DTDHandler, DocumentHandler и ErrorHandler. Он устарел, но включён в SAX2 для поддержки устаревших приложений SAX1. Приложения SAX2 должны использовать класс DefaultHandler вместо него.
Разработчики приложений могут расширить этот класс, когда им нужно реализовать только часть интерфейса; разработчики парсеров могут создать экземпляр этого класса, чтобы предоставить обработчики по умолчанию, когда приложение не предоставило свои собственные.
Обратите внимание, что использование этого класса необязательно.
- С момента:
- SAX 1.0
- См. также:
-
EntityResolver,DTDHandler,DocumentHandler,ErrorHandler
Конструкторы
| Конструктор и описание |
|---|
HandlerBase() Устаревший. |
Методы
| Модификатор и тип | Метод и описание |
|---|---|
void |
characters(char[] ch,
int start,
int length) Устаревший. Получение уведомления о символьных данных внутри элемента. |
void |
endDocument() Устаревший. Получение уведомления об окончании документа. |
void |
endElement(String name) Устаревший. Получение уведомления об окончании элемента. |
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 |
startDocument() Устаревший. Получение уведомления о начале документа. |
void |
startElement(String name,
AttributeList attributes) Устаревший. Получение уведомления о начале элемента. |
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 Конструкторы
HandlerBase
public HandlerBase()
Устаревшее.
Методы
resolveEntity
public InputSource resolveEntity(String publicId,
String systemId)
throws SAXException Устаревшее.
Разрешить внешнюю сущность.
Всегда возвращает null, чтобы парсер использовал системный идентификатор, указанный в XML-документе. Этот метод реализует поведение по умолчанию SAX: разработчики приложений могут переопределить его в подклассе для выполнения специальных переводов, таких как поиск в каталоге или перенаправление URI.
- Указано в:
-
resolveEntityв интерфейсеEntityResolver - Параметры:
-
publicId- Общедоступный идентификатор или null, если он недоступен. -
systemId- Системный идентификатор, предоставленный в XML-документе. - Возвращает:
- Новый источник ввода или null, чтобы потребовать поведение по умолчанию.
- Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
EntityResolver.resolveEntity(java.lang.String, java.lang.String)
notationDecl
public void notationDecl(String name,
String publicId,
String systemId) Устаревшее.
Получение уведомления о декларации обозначения.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе, если они хотят отслеживать обозначения, объявленные в документе.
- Указано в:
-
notationDeclв интерфейсеDTDHandler - Параметры:
-
name- Название обозначения. -
publicId- Общедоступный идентификатор обозначения или null, если он недоступен. -
systemId- Системный идентификатор обозначения. - См. также:
DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)
unparsedEntityDecl
public void unparsedEntityDecl(String name,
String publicId,
String systemId,
String notationName) Устаревшее.
Получение уведомления об объявлении необработанной сущности.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для отслеживания необработанных сущностей, объявленных в документе.
- Указано в:
-
unparsedEntityDeclв интерфейсеDTDHandler - Параметры:
-
name- Название сущности. -
publicId- Общедоступный идентификатор сущности или null, если он недоступен. -
systemId- Системный идентификатор сущности. -
notationName- Название связанного обозначения. - См. также:
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
setDocumentLocator
public void setDocumentLocator(Locator locator)
Устаревшее.
Получение объекта Locator для событий документа.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе, если хотят сохранить локатор для использования с другими событиями документа.
- Указано в:
-
setDocumentLocatorв интерфейсеDocumentHandler - Параметры:
-
locator- Локатор для всех событий SAX документа. - См. также:
-
DocumentHandler.setDocumentLocator(org.xml.sax.Locator),Locator
startDocument
public void startDocument()
throws SAXException Устаревшее.
Получение уведомления о начале документа.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определенных действий в начале документа (например, выделения корневого узла дерева или создания выходного файла).
- Указано в:
-
startDocumentв интерфейсеDocumentHandler - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
DocumentHandler.startDocument()
endDocument
public void endDocument()
throws SAXException Устаревшее.
Получение уведомления об окончании документа.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определенных действий в конце документа (например, завершения дерева или закрытия выходного файла).
- Указано в:
-
endDocumentв интерфейсеDocumentHandler - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
DocumentHandler.endDocument()
startElement
public void startElement(String name,
AttributeList attributes)
throws SAXException Устаревшее.
Получение уведомления о начале элемента.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определенных действий в начале каждого элемента (например, выделения нового узла дерева или записи вывода в файл).
- Указано в:
-
startElementв интерфейсеDocumentHandler - Параметры:
-
name- Имя типа элемента. -
attributes- Указанные или установленные по умолчанию атрибуты. - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
DocumentHandler.startElement(java.lang.String, org.xml.sax.AttributeList)
endElement
public void endElement(String name)
throws SAXException Устаревшее.
Получение уведомления об окончании элемента.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определенных действий в конце каждого элемента (например, завершения узла дерева или записи вывода в файл).
- Указано в:
-
endElementв интерфейсеDocumentHandler - Параметры:
-
name- имя элемента - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
DocumentHandler.endElement(java.lang.String)
characters
public void characters(char[] ch,
int start,
int length)
throws SAXException Устаревшее.
Получение уведомления о данных символов внутри элемента.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод для выполнения определенных действий для каждого фрагмента данных символов (например, добавления данных в узел или буфер, или печати в файл).
- Указано в:
-
charactersв интерфейсеDocumentHandler - Параметры:
-
ch- Символы. -
start- Начальная позиция в массиве символов. -
length- Количество символов для использования из массива символов. - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
DocumentHandler.characters(char[], int, int)
ignorableWhitespace
public void ignorableWhitespace(char[] ch,
int start,
int length)
throws SAXException Устаревшее.
Получение уведомления о пренебрежимых пробелах в содержимом элемента.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод для выполнения определенных действий для каждого фрагмента пренебрежимых пробелов (например, добавления данных в узел или буфер, или печати в файл).
- Указано в:
-
ignorableWhitespaceв интерфейсеDocumentHandler - Параметры:
-
ch- Символы пробелов. -
start- Начальная позиция в массиве символов. -
length- Количество символов для использования из массива символов. - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
DocumentHandler.ignorableWhitespace(char[], int, int)
processingInstruction
public void processingInstruction(String target,
String data)
throws SAXException Устаревшее.
Получение уведомления об инструкции обработки.
По умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определенных действий для каждой инструкции обработки, например, установки переменных состояния или вызова других методов.
- Указано в:
-
processingInstructionв интерфейсеDocumentHandler - Параметры:
-
target- Цель инструкции обработки. -
data- Данные инструкции обработки или null, если они не указаны. - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
DocumentHandler.processingInstruction(java.lang.String, java.lang.String)
warning
public void warning(SAXParseException e)
throws SAXException Устаревшее.
Получение уведомления об ошибке предупреждения парсера.
Реализация по умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определенных действий для каждого предупреждения, например, вставки сообщения в файл журнала или вывода на консоль.
- Указано в:
-
warningв интерфейсеErrorHandler - Параметры:
-
e- Информация о предупреждении, закодированная как исключение. - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
-
ErrorHandler.warning(org.xml.sax.SAXParseException),SAXParseException
error
public void error(SAXParseException e)
throws SAXException Устаревшее.
Получение уведомления о восстанавливаемой ошибке парсера.
Реализация по умолчанию ничего не делает. Разработчики приложений могут переопределить этот метод в подклассе для выполнения определенных действий для каждой ошибки, например, вставки сообщения в файл журнала или вывода на консоль.
- Указано в:
-
errorв интерфейсеErrorHandler - Параметры:
-
e- Информация о предупреждении, закодированная как исключение. - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
-
ErrorHandler.warning(org.xml.sax.SAXParseException),SAXParseException
fatalError
public void fatalError(SAXParseException e)
throws SAXException Устаревшее.
Сообщите об ошибке фатального разбора XML.
Реализация по умолчанию выбрасывает SAXParseException. Разработчики приложений могут переопределить этот метод в подклассе, если им нужно выполнить определенные действия для каждой фатальной ошибки (например, собрать все ошибки в одном отчете): в любом случае приложение должно остановить всю обычную обработку при вызове этого метода, поскольку документ больше не надежен, и парсер больше не может сообщать события разбора.
- Определено в:
-
fatalErrorв интерфейсеErrorHandler - Параметры:
-
e- Информация об ошибке, закодированная в виде исключения. - Исключения:
-
SAXException- Любое исключение SAX, возможно, обертывающее другое исключение. - См. также:
-
ErrorHandler.fatalError(org.xml.sax.SAXParseException),SAXParseException
© 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.