Spec-Zone.ru › OpenJDK 24

Класс DefaultHandler

java.lang.Object
org.xml.sax.helpers.DefaultHandler
Все реализованные интерфейсы:
ContentHandler, DTDHandler, EntityResolver, ErrorHandler
Прямые известные подклассы:
DefaultHandler2
public class DefaultHandler extends Object implements EntityResolver, DTDHandler, ContentHandler, ErrorHandler
Базовый класс по умолчанию для обработчиков событий SAX2.

Этот класс доступен в качестве удобного базового класса для приложений SAX2: он предоставляет реализации по умолчанию для всех обратных вызовов в четырёх основных классах обработчиков SAX2:

  • EntityResolver
  • DTDHandler
  • ContentHandler
  • ErrorHandler

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

Этот класс заменяет устаревший класс SAX1 HandlerBase.

С момента:
1.4, SAX 2.0
См. также:
  • EntityResolver
  • DTDHandler
  • ContentHandler
  • ErrorHandler

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

Конструктор Описание
DefaultHandler()
Создаёт DefaultHandler.

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

Модификатор и тип Метод Описание
void characters(char[] ch, int start, int length)
Получение уведомления о данных символов внутри элемента.
void endDocument()
Получение уведомления о конце документа.
void endElement(String uri, String localName, String qName)
Получение уведомления о конце элемента.
void endPrefixMapping(String prefix)
Получение уведомления о конце сопоставления пространства имён.
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 skippedEntity(String name)
Получение уведомления о пропущенной сущности.
void startDocument()
Получение уведомления о начале документа.
void startElement(String uri, String localName, String qName, Attributes attributes)
Получение уведомления о начале элемента.
void startPrefixMapping(String prefix, String uri)
Получение уведомления о начале сопоставления пространства имён.
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

Методы, объявленные в интерфейсе org.xml.sax.ContentHandler

declaration

Подробное описание конструкторов

DefaultHandler

public DefaultHandler()
Создаёт DefaultHandler.

Подробное описание методов

resolveEntity

public InputSource resolveEntity(String publicId, String systemId) throws IOException, SAXException
Разрешает внешнюю сущность.

Всегда возвращает null, чтобы парсер использовал системный идентификатор, предоставленный в документе XML. Этот метод реализует стандартное поведение SAX: разработчики приложений могут переопределить его в подклассе, чтобы выполнить специальные преобразования, такие как поиск в каталоге или перенаправление URI.

Определено в:
resolveEntity в интерфейсе EntityResolver
Параметры:
publicId - Публичный идентификатор или null, если он недоступен.
systemId - Системный идентификатор, предоставленный в документе XML.
Возвращает:
Новый источник входных данных или null, чтобы использовать стандартное поведение.
Исключения:
IOException - Если произошла ошибка при настройке нового источника входных данных.
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • EntityResolver.resolveEntity(java.lang.String, java.lang.String)

notationDecl

public void notationDecl(String name, String publicId, String systemId) throws SAXException
Получение уведомления о декларации обозначения.

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

Определено в:
notationDecl в интерфейсе DTDHandler
Параметры:
name - Имя обозначения.
publicId - Публичный идентификатор обозначения или null, если он недоступен.
systemId - Системный идентификатор обозначения.
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)

unparsedEntityDecl

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

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

Определено в:
unparsedEntityDecl в интерфейсе DTDHandler
Параметры:
name - Имя сущности.
publicId - Публичный идентификатор сущности или null, если он недоступен.
systemId - Системный идентификатор сущности.
notationName - Имя связанного обозначения.
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

setDocumentLocator

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

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

Определено в:
setDocumentLocator в интерфейсе ContentHandler
Параметры:
locator - Локатор для всех событий SAX документа.
См. также:
  • ContentHandler.setDocumentLocator(org.xml.sax.Locator)
  • Locator

startDocument

public void startDocument() throws SAXException
Получение уведомления о начале документа.

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

Определено в:
startDocument в интерфейсе ContentHandler
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ContentHandler.startDocument()

endDocument

public void endDocument() throws SAXException
Получение уведомления об окончании документа.

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

Определено в:
endDocument в интерфейсе ContentHandler
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ContentHandler.endDocument()

startPrefixMapping

public void startPrefixMapping(String prefix, String uri) throws SAXException
Получение уведомления о начале сопоставления пространства имён.

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

Определено в:
startPrefixMapping в интерфейсе ContentHandler
Параметры:
prefix - Префикс пространства имён, который объявляется.
uri - URI пространства имён, сопоставленного с префиксом.
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)

endPrefixMapping

public void endPrefixMapping(String prefix) throws SAXException
Получение уведомления об окончании сопоставления пространства имён.

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

Определено в:
endPrefixMapping в интерфейсе ContentHandler
Параметры:
prefix - Префикс пространства имён, который объявляется.
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ContentHandler.endPrefixMapping(java.lang.String)

startElement

public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException
Получение уведомления о начале элемента.

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

Определено в:
startElement в интерфейсе ContentHandler
Параметры:
uri - URI пространства имён или пустая строка, если элемент не имеет URI пространства имён или обработка пространства имён не выполняется.
localName - Локальное имя (без префикса) или пустая строка, если обработка пространства имён не выполняется.
qName - Квалифицированное имя (с префиксом) или пустая строка, если квалифицированные имена недоступны.
attributes - Атрибуты, присоединённые к элементу. Если атрибутов нет, это будет пустой объект Attributes.
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endElement

public void endElement(String uri, String localName, String qName) throws SAXException
Получение уведомления об окончании элемента.

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

Определено в:
endElement в интерфейсе ContentHandler
Параметры:
uri - URI пространства имён или пустая строка, если элемент не имеет URI пространства имён или обработка пространства имён не выполняется.
localName - Локальное имя (без префикса) или пустая строка, если обработка пространства имён не выполняется.
qName - Квалифицированное имя (с префиксом) или пустая строка, если квалифицированные имена недоступны.
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

characters

public void characters(char[] ch, int start, int length) throws SAXException
Получить уведомление о данных символов внутри элемента.

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

Определено в:
characters в интерфейсе ContentHandler
Параметры:
ch - Символы.
start - Начальная позиция в массиве символов.
length - Количество символов для использования из массива символов.
Выбрасывает:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ContentHandler.characters(char[], int, int)

ignorableWhitespace

public void ignorableWhitespace(char[] ch, int start, int length) throws SAXException
Получить уведомление об игнорируемых пробелах в содержимом элемента.

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

Определено в:
ignorableWhitespace в интерфейсе ContentHandler
Параметры:
ch - Символы пробелов.
start - Начальная позиция в массиве символов.
length - Количество символов для использования из массива символов.
Выбрасывает:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ContentHandler.ignorableWhitespace(char[], int, int)

processingInstruction

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

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

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

skippedEntity

public void skippedEntity(String name) throws SAXException
Получить уведомление о пропущенном сущности.

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

Определено в:
skippedEntity в интерфейсе ContentHandler
Параметры:
name - Имя пропущенной сущности.
Выбрасывает:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
См. также:
  • ContentHandler.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, 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://download.java.net/java/early_access/jdk24/docs/api/java.xml/org/xml/sax/helpers/DefaultHandler.html

Spec-Zone.ru

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