Spec-Zone.ru › OpenJDK 21

Класс HandlerBase

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

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

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

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

С:
1.4, SAX 1.0
См. также:
  • EntityResolver
  • DTDHandler
  • DocumentHandler
  • ErrorHandler

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

Конструктор Описание
HandlerBase()
Устарело.
Создаёт 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()
Устаревший.
Создаёт 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)

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

public void processingInstruction(String target, String data) throws SAXException
Устарело.
Получение уведомления об обработке инструкции.

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

Указано в:
processingInstruction в интерфейсе DocumentHandler
Параметры:
target - Цель инструкции обработки.
data - Данные инструкции обработки или null, если они не предоставлены.
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • DocumentHandler.processingInstruction(java.lang.String, java.lang.String)

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

public void warning(SAXParseException e) throws SAXException
Устарело.
Получение уведомления о предупреждении анализатора.

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

Указано в:
warning в интерфейсе ErrorHandler
Параметры:
e - Информация о предупреждении, закодированная как исключение.
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ErrorHandler.warning(org.xml.sax.SAXParseException)
  • SAXParseException

Ошибка

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, 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/HandlerBase.html

Spec-Zone.ru

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