Spec-Zone.ru › OpenJDK 25

Класс 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)
Устарело.
Получает уведомление о предупреждении парсера.

Методы, объявленные в классе 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(String, String)

notationDecl

public void notationDecl(String name, String publicId, String systemId)
Устарело.
Получает уведомление об объявлении нотации.

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

Определён в:
notationDecl в интерфейсе DTDHandler
Параметры:
name — имя нотации.
publicId — общедоступный идентификатор нотации или null, если он недоступен.
systemId — системный идентификатор нотации.
См. также:
  • DTDHandler.notationDecl(String, String, String)

unparsedEntityDecl

public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
Устарело.
Получает уведомление об объявлении неразбираемой сущности.

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

Определён в:
unparsedEntityDecl в интерфейсе DTDHandler
Параметры:
name — имя сущности.
publicId — общедоступный идентификатор сущности или null, если он недоступен.
systemId — системный идентификатор сущности.
notationName — имя связанной нотации.
См. также:
  • DTDHandler.unparsedEntityDecl(String, String, String, String)

setDocumentLocator

public void setDocumentLocator(Locator locator)
Устарело.
Получает объект Locator для событий документа.

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

Определён в:
setDocumentLocator в интерфейсе DocumentHandler
Параметры:
locator — локатор для всех событий документа SAX.
См. также:
  • DocumentHandler.setDocumentLocator(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(String, AttributeList)

endElement

public void endElement(String name) throws SAXException
Устарело.
Получает уведомление об окончании элемента.

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

Определён в:
endElement в интерфейсе DocumentHandler
Параметры:
name — имя элемента
Вызывает:
SAXException — любое исключение SAX, возможно оборачивающее другое исключение.
См. также:
  • DocumentHandler.endElement(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(String, String)

warning

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

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

Определён в:
warning в интерфейсе ErrorHandler
Параметры:
e — сведения о предупреждении, представленные в виде исключения.
Вызывает:
SAXException — любое исключение SAX, возможно оборачивающее другое исключение.
См. также:
  • ErrorHandler.warning(SAXParseException)
  • SAXParseException

error

public void error(SAXParseException e) throws SAXException
Устарело.
Получает уведомление об исправимой ошибке парсера.

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

Определён в:
error в интерфейсе ErrorHandler
Параметры:
e — сведения о предупреждении, представленные в виде исключения.
Вызывает:
SAXException — любое исключение SAX, возможно оборачивающее другое исключение.
См. также:
  • ErrorHandler.warning(SAXParseException)
  • SAXParseException

fatalError

public void fatalError(SAXParseException e) throws SAXException
Устарело.
Сообщает о неисправимой ошибке разбора XML.

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

Определён в:
fatalError в интерфейсе ErrorHandler
Параметры:
e — сведения об ошибке, представленные в виде исключения.
Вызывает:
SAXException — любое исключение SAX, возможно оборачивающее другое исключение.
См. также:
  • ErrorHandler.fatalError(SAXParseException)
  • SAXParseException

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, обзоры концепций, определения терминов, обходные решения и рабочие примеры кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или её аффилированных лиц в США и других странах.
Авторские права © 1993, 2025, Oracle и/или её аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

© 1993, 2025, 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/25/docs/api/java.xml/org/xml/sax/HandlerBase.html

Spec-Zone.ru

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