Spec-Zone.ru › OpenJDK 17

Класс 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, 2021, 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/17/docs/api/java.xml/org/xml/sax/HandlerBase.html

Spec-Zone.ru

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