Класс HandlerBase

Все реализованные интерфейсы:
DocumentHandler, DTDHandler, EntityResolver, ErrorHandler 
@Deprecated(since="1.5")
public class HandlerBase
extends Object
implements EntityResolver, DTDHandler, DocumentHandler, ErrorHandler
Устаревший.
Этот класс работает с устаревшим интерфейсом DocumentHandler. Он был заменён классом SAX2 DefaultHandler.

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

Этот модуль, как исходный код, так и документация, находится в общественном достоянии и НЕ ГАРАНТИРУЕТСЯ. См. http://www.saxproject.org для получения дополнительной информации.

Этот класс реализует поведение по умолчанию для четырёх интерфейсов SAX1: EntityResolver, DTDHandler, DocumentHandler и ErrorHandler. Сейчас он устарел, но включён в SAX2 для поддержки устаревших приложений SAX1. Приложения SAX2 должны использовать класс DefaultHandler вместо него.

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

Обратите внимание, что использование этого класса необязательно.

С:
1.4, 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.
https://docs.oracle.com/en/java/javase/11/docs/api/java.xml/org/xml/sax/HandlerBase.html

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