Класс DefaultHandler2

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.xml.sax.ext.DefaultHandler2

Все реализованные интерфейсы:: ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, EntityResolver2, LexicalHandler

public class DefaultHandler2 extends DefaultHandler implements LexicalHandler, DeclHandler, EntityResolver2

Этот класс расширяет базовый обработчик SAX2 для поддержки расширений SAX2 LexicalHandler, DeclHandler и EntityResolver2. За исключением переопределения исходного метода SAX1 resolveEntity(), добавленные методы обработчика просто возвращают значение. Подклассы могут переопределять все методы по отдельности.

Примечание: этот класс может еще узнать, что вызов ContentHandler.setDocumentLocator() может получить объект Locator2, а вызов ContentHandler.startElement() может получить объект Attributes2.

С тех пор:: 1.5, SAX 2.0 (extensions 1.1 alpha)

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

Конструктор	Описание
`DefaultHandler2()`	Создаёт обработчик, игнорирующий все события разбора.

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

Модификатор и тип	Метод	Описание
`void`	`attributeDecl(String eName, String aName, String type, String mode, String value)`	Сообщает о объявлении типа атрибута.
`void`	`comment(char[] ch, int start, int length)`	Сообщает об XML-комментарии в любом месте документа.
`void`	`elementDecl(String name, String model)`	Сообщает об объявлении типа элемента.
`void`	`endCDATA()`	Сообщает об окончании раздела CDATA.
`void`	`endDTD()`	Сообщает об окончании объявлений DTD.
`void`	`endEntity(String name)`	Сообщает об окончании сущности.
`void`	`externalEntityDecl(String name, String publicId, String systemId)`	Сообщает об объявлении внешней сущности, проанализированной извне.
`InputSource`	`getExternalSubset(String name, String baseURI)`	Сообщает анализатору, что если во внешнем подмножестве документа не было объявлено ничего, то оно не должно использоваться.
`void`	`internalEntityDecl(String name, String value)`	Сообщает об объявлении внутренней сущности.
`InputSource`	`resolveEntity(String publicId, String systemId)`	Вызывает `EntityResolver2.resolveEntity()` с именем сущности null и базовым URI.
`InputSource`	`resolveEntity(String name, String publicId, String baseURI, String systemId)`	Сообщает анализатору разрешить systemId относительно baseURI и прочитать текст сущности из полученного абсолютного URI.
`void`	`startCDATA()`	Сообщает о начале раздела CDATA.
`void`	`startDTD(String name, String publicId, String systemId)`	Сообщает о начале объявлений DTD, если они есть.
`void`	`startEntity(String name)`	Сообщает о начале некоторых внутренних и внешних XML-сущностей.

Методы, унаследованные от класса org.xml.sax.helpers.DefaultHandler

characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping, unparsedEntityDecl, warning

Методы, унаследованные от класса java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

declaration

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

DefaultHandler2

public DefaultHandler2()

Создаёт обработчик, который игнорирует все события разбора.

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

startCDATA

public void startCDATA() throws SAXException

Описание скопировано из интерфейса: LexicalHandler

Сообщает о начале раздела CDATA.

Содержимое раздела CDATA будет сообщено через обычное событие characters; это событие предназначено только для сообщения о границе.

Определено в:

startCDATA в интерфейсе LexicalHandler

Исключение:

SAXException - Приложение может вызвать исключение.

См. также:

endCDATA

public void endCDATA() throws SAXException

Описание скопировано из интерфейса: LexicalHandler

Сообщает об окончании раздела CDATA.

Определено в:

endCDATA в интерфейсе LexicalHandler

Исключение:

SAXException - Приложение может вызвать исключение.

См. также:

startDTD

public void startDTD(String name, String publicId, String systemId) throws SAXException

Описание скопировано из интерфейса: LexicalHandler

Сообщает о начале объявлений DTD, если таковые имеются.

Этот метод предназначен для сообщения о начале объявления DOCTYPE; если в документе нет объявления DOCTYPE, этот метод не будет вызван.

Все объявления, сообщённые через DTDHandler или DeclHandler события, должны появиться между событиями startDTD и endDTD. Объявления предполагаются принадлежащими внутреннему подмножеству DTD, если они не появляются между startEntity и endEntity событиями. Комментарии и инструкции обработки из DTD также должны быть сообщены между событиями startDTD и endDTD в их исходном порядке (логического) появления; однако они не обязаны появляться в своих правильных местах относительно событий DTDHandler или DeclHandler.

Обратите внимание, что события start/endDTD появятся внутри событий start/endDocument от ContentHandler и перед первым событием startElement.

Определено в:

startDTD в интерфейсе LexicalHandler

Параметры:

name - Имя типа документа.

publicId - Объявленный общедоступный идентификатор для внешнего подмножества DTD, или null, если он не был объявлен.

systemId - Объявленный системный идентификатор для внешнего подмножества DTD, или null, если он не был объявлен. (Обратите внимание, что это не разрешается относительно базового URI документа.)

Исключение:

SAXException - Приложение может вызвать исключение.

См. также:

endDTD

public void endDTD() throws SAXException

Описание скопировано из интерфейса: LexicalHandler

Сообщает об окончании объявлений DTD.

Этот метод предназначен для сообщения об окончании объявления DOCTYPE; если в документе нет объявления DOCTYPE, этот метод не будет вызван.

Определено в:

endDTD в интерфейсе LexicalHandler

Исключение:

SAXException - Приложение может вызвать исключение.

См. также:

startEntity

public void startEntity(String name) throws SAXException

Описание скопировано из интерфейса: LexicalHandler

Сообщает о начале некоторых внутренних и внешних XML сущностей.

Сообщения о параметрах сущностей (включая внешнее подмножество DTD) являются необязательными, и драйверы SAX2, которые сообщают события LexicalHandler, могут их не реализовывать; вы можете использовать функцию http://xml.org/sax/features/lexical-handler/parameter-entities для запроса или управления сообщениями о параметрах сущностей.

Общие сущности сообщаются с их обычными именами, параметрические сущности имеют '%' перед своими именами, а внешнее подмножество DTD имеет псевдо-имя "[dtd]".

Когда драйвер SAX2 предоставляет эти события, все остальные события должны быть должным образом вложены внутри событий start/end entity. Нет дополнительного требования, чтобы события из DeclHandler или DTDHandler были должным образом упорядочены.

Обратите внимание, что пропущенные сущности будут сообщены через событие skippedEntity, которое является частью интерфейса ContentHandler.

Из-за потоковой модели событий, используемой SAX, некоторые границы сущностей не могут быть сообщены в каких-либо обстоятельствах:

общие сущности внутри значений атрибутов
параметрические сущности внутри объявлений

Они будут молча расширены, без каких-либо указаний на то, где были исходные границы сущностей.

Обратите также внимание, что границы ссылок символов (которые по сути не являются сущностями) не сообщаются.

Все события start/endEntity должны быть должным образом вложены.

Определено в:

startEntity в интерфейсе LexicalHandler

Параметры:

name - Имя сущности. Если это параметрическая сущность, имя будет начинаться с '%', а если это внешнее подмножество DTD, то это будет "[dtd]".

Исключение:

SAXException - Приложение может вызвать исключение.

См. также:

endEntity

public void endEntity(String name) throws SAXException

Описание скопировано из интерфейса: LexicalHandler

Сообщает об окончании сущности.

Определено в:

endEntity в интерфейсе LexicalHandler

Параметры:

name - Имя сущности, которая завершается.

Исключение:

SAXException - Приложение может вызвать исключение.

См. также:

comment

public void comment(char[] ch, int start, int length) throws SAXException

Описание скопировано из интерфейса: LexicalHandler

Сообщает о комментарии XML в любом месте документа.

Этот обратный вызов будет использован для комментариев внутри или вне элемента документа, включая комментарии во внешнем подмножестве DTD (если оно читается). Комментарии в DTD должны быть должным образом вложены внутри событий start/endDTD и start/endEntity (если они используются).

Определено в:: comment в интерфейсе LexicalHandler
Параметры:: ch - Массив, содержащий символы в комментарии.; start - Начальная позиция в массиве.; length - Количество символов для использования из массива.
Исключение:: SAXException - Приложение может вызвать исключение.

attributeDecl

public void attributeDecl(String eName, String aName, String type, String mode, String value) throws SAXException

Описание скопировано из интерфейса: DeclHandler

Сообщает об объявлении типа атрибута.

Будет сообщено только эффективное (первое) объявление атрибута. Тип будет одним из строк "CDATA", "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", "ENTITIES", скобками группой маркеров с разделителем "|" и удаленными пробелами, или словом "NOTATION", за которым следует пробел, за которым следует группой маркеров в скобках со всеми удаленными пробелами.

Значение будет значением, сообщенным приложениям, надлежащим образом нормализованным и с расширенными ссылками на сущности и символы.

Определено в:: attributeDecl в интерфейсе DeclHandler
Параметры:: eName - Имя связанного элемента.; aName - Имя атрибута.; type - Строка, представляющая тип атрибута.; mode - Строка, представляющая режим установки атрибута ("#IMPLIED", "#REQUIRED" или "#FIXED") или null, если ни один из них не применим.; value - Строка, представляющая значение по умолчанию атрибута, или null, если его нет.
Исключение:: SAXException - Приложение может вызвать исключение.

elementDecl

public void elementDecl(String name, String model) throws SAXException

Описание скопировано из интерфейса: DeclHandler

Сообщает об объявлении типа элемента.

Модель содержимого будет состоять из строки "EMPTY", строки "ANY" или скобочной группы, необязательно сопровождаемой указателем частоты появления. Модель будет нормализована, так что все сущности-параметры будут полностью разрешены, а все пробелы будут удалены, и она будет включать в себя окружающие скобки. Другая нормализация (например, удаление излишних скобок или упрощение указателей частоты появления) остается на усмотрение анализатора.

Указано в:: elementDecl в интерфейсе DeclHandler
Параметры:: name - Имя типа элемента.; model - Модель содержимого в виде нормализованной строки.
Исключения:: SAXException - Приложение может вызвать исключение.

externalEntityDecl

public void externalEntityDecl(String name, String publicId, String systemId) throws SAXException

Описание скопировано из интерфейса: DeclHandler

Сообщает об объявлении внешней сущности.

Будет сообщено только эффективное (первое) объявление для каждой сущности.

Если идентификатор системы является URL-адресом, анализатор должен полностью разрешить его перед передачей приложению.

Указано в:

externalEntityDecl в интерфейсе DeclHandler

Параметры:

name - Имя сущности. Если это сущность-параметр, имя будет начинаться с '%'.

publicId - Открытый идентификатор сущности или null, если не был задан.

systemId - Идентификатор системы сущности.

Исключения:

SAXException - Приложение может вызвать исключение.

См. также:

internalEntityDecl

public void internalEntityDecl(String name, String value) throws SAXException

Описание скопировано из интерфейса: DeclHandler

Сообщает об объявлении внутренней сущности.

Будет сообщено только эффективное (первое) объявление для каждой сущности. Все сущности-параметры в значении будут расширены, но общие сущности не будут.

Указано в:

internalEntityDecl в интерфейсе DeclHandler

Параметры:

name - Имя сущности. Если это сущность-параметр, имя будет начинаться с '%'.

value - Текст замены сущности.

Исключения:

SAXException - Приложение может вызвать исключение.

См. также:

getExternalSubset

public InputSource getExternalSubset(String name, String baseURI) throws SAXException, IOException

Уведомляет анализатор, что если во внешнем документе не было объявлено внешнего подмножества, оно не должно быть использовано.

Указано в:: getExternalSubset в интерфейсе EntityResolver2
Параметры:: name - Идентифицирует корневой элемент документа. Это имя взято из объявления DOCTYPE (если доступно) или из фактического корневого элемента.; baseURI - Базовый URI документа, служащий дополнительным подсказкой для выбора внешнего подмножества. Это всегда абсолютный URI, если он не null, потому что XMLReader получил InputSource без него.
Возвращает:: Объект InputSource, описывающий новое внешнее подмножество, которое должно использоваться анализатором, или null, чтобы указать, что внешнее подмножество не предоставлено.
Исключения:: SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.; IOException - Вероятно, указывает на неудачу при создании нового InputStream или Reader, или некорректный URL.

resolveEntity

public InputSource resolveEntity(String name, String publicId, String baseURI, String systemId) throws SAXException, IOException

Уведомляет анализатор о разрешении systemId по отношению к baseURI и чтении текста сущности из полученного абсолютного URI. Обратите внимание, что из-за того, что более старый метод DefaultHandler.resolveEntity() переопределен для вызова этого, этот метод может иногда вызываться с name и baseURI, равными null, и с systemId, уже приведенным к абсолютному виду.

Указано в:: resolveEntity в интерфейсе EntityResolver2
Параметры:: name - Идентифицирует внешнюю сущность, которая разрешается. Либо "[dtd]" для внешнего подмножества, либо имя, начинающееся с '%', чтобы указать сущность-параметр, или же имя общей сущности. Это никогда не null, когда вызывается SAX2-анализатором.; publicId - Открытый идентификатор внешней сущности, на которую ссылаются (нормализованный, как требуется спецификацией XML), или null, если не был предоставлен.; baseURI - URI, относительно которого интерпретируются относительные systemIDs. Это всегда абсолютный URI, если он не null (вероятно, потому, что XMLReader получил InputSource без него). Этот URI определён спецификацией XML как URI, связанный с "<", начинающим соответствующее объявление.; systemId - Идентификатор системы внешней сущности, на которую ссылаются; относительный или абсолютный URI. Это никогда не null, когда вызывается SAX2-анализатором; только объявленные сущности и любое внешнее подмножество разрешаются такими анализаторами.
Возвращает:: Объект InputSource, описывающий новый источник ввода, который должен использоваться анализатором. Возврат null направляет анализатор на разрешение systemID относительно baseURI и открытие соединения с результирующим URI.
Исключения:: SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.; IOException - Вероятно, указывает на неудачу при создании нового InputStream или Reader, или некорректный URL.

resolveEntity

public InputSource resolveEntity(String publicId, String systemId) throws SAXException, IOException

Вызывает EntityResolver2.resolveEntity() с null именем сущности и base URI. Вам нужно переопределить только этот метод, чтобы использовать этот класс.

Указано в:

resolveEntity в интерфейсе EntityResolver

Переопределяет:

resolveEntity в классе DefaultHandler

Параметры:

publicId - Открытый идентификатор, или null, если он недоступен.

systemId - Идентификатор системы, предоставленный в документе XML.

Возвращает:

Новый источник ввода или null, чтобы потребовать стандартное поведение.

Исключения:

SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.

IOException - Если произошла ошибка при настройке нового источника ввода.

См. также:

© 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/ext/DefaultHandler2.html