Класс XMLFilterImpl

java.lang.Object

org.xml.sax.helpers.XMLFilterImpl

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

public class XMLFilterImpl extends Object implements XMLFilter, EntityResolver, DTDHandler, ContentHandler, ErrorHandler

Базовый класс для создания XML-фильтра.

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

С тех пор:

1.4, SAX 2.0

См. также:

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

Конструктор	Описание
`XMLFilterImpl()`	Создает пустой XML-фильтр без родителя.
`XMLFilterImpl(XMLReader parent)`	Создает XML-фильтр со указанным родителем.

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

Модификатор и тип	Метод	Описание
`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)`	Фильтрация события критической ошибки.
`ContentHandler`	`getContentHandler()`	Получение обработчика событий содержимого.
`DTDHandler`	`getDTDHandler()`	Получение текущего обработчика событий DTD.
`EntityResolver`	`getEntityResolver()`	Получение текущего разрешителя сущностей.
`ErrorHandler`	`getErrorHandler()`	Получение текущего обработчика событий ошибок.
`boolean`	`getFeature(String name)`	Получение значения функции.
`XMLReader`	`getParent()`	Получение родительского объекта чтеца.
`Object`	`getProperty(String name)`	Получение значения свойства.
`void`	`ignorableWhitespace(char[] ch, int start, int length)`	Фильтрация события игнорируемого пробела.
`void`	`notationDecl(String name, String publicId, String systemId)`	Фильтрация события объявления обозначения.
`void`	`parse(String systemId)`	Обработка документа.
`void`	`parse(InputSource input)`	Обработка документа.
`void`	`processingInstruction(String target, String data)`	Фильтрация события инструкции обработки.
`InputSource`	`resolveEntity(String publicId, String systemId)`	Фильтрация разрешения внешней сущности.
`void`	`setContentHandler(ContentHandler handler)`	Устанавливает обработчик событий содержимого.
`void`	`setDocumentLocator(Locator locator)`	Фильтрация события нового локатора документа.
`void`	`setDTDHandler(DTDHandler handler)`	Установка обработчика событий DTD.
`void`	`setEntityResolver(EntityResolver resolver)`	Установка разрешителя сущностей.
`void`	`setErrorHandler(ErrorHandler handler)`	Установка обработчика событий ошибок.
`void`	`setFeature(String name, boolean value)`	Установка значения функции.
`void`	`setParent(XMLReader parent)`	Установка родительского объекта чтеца.
`void`	`setProperty(String name, Object value)`	Установка значения свойства.
`void`	`skippedEntity(String name)`	Фильтрация события пропущенной сущности.
`void`	`startDocument()`	Фильтрация события начала документа.
`void`	`startElement(String uri, String localName, String qName, Attributes atts)`	Фильтрация события начала элемента.
`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

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

XMLFilterImpl

public XMLFilterImpl()

Создать пустой фильтр XML без родителя.

У этого фильтра не будет родителя: вы должны назначить родителя перед началом разбора или выполнить какую-либо настройку с помощью setFeature или setProperty, если не используете его как чистого потребителя событий, а не в качестве XMLReader.

См. также:

XMLFilterImpl

public XMLFilterImpl(XMLReader parent)

Создать фильтр XML с указанным родителем.

Параметры:

parent - указанный родитель

См. также:

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

setParent

public void setParent(XMLReader parent)

Установить родительский ридер.

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

Если родительский ридер не установлен, любая попытка выполнить разбор или установить или получить функцию или свойство завершится неудачей.

Указано в:

setParent в интерфейсе XMLFilter

Параметры:

parent - Родительский XML-ридер.

См. также:

getParent

public XMLReader getParent()

Получить родительский ридер.

Указано в:

getParent в интерфейсе XMLFilter

Возвращает:

Родительский XML-ридер или null, если он не установлен.

См. также:

setFeature

public void setFeature(String name, boolean value) throws SAXNotRecognizedException, SAXNotSupportedException

Установить значение функции.

Это всегда завершится неудачей, если родительский элемент равен null.

Указано в:

setFeature в интерфейсе XMLReader

Параметры:

name - Имя функции.

value - Требуемое значение функции.

Исключения:

SAXNotRecognizedException - Если значение функции нельзя назначить или получить из родителя.

SAXNotSupportedException - Если родитель распознает имя функции, но не может установить запрошенное значение.

См. также:

getFeature

public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException

Получить значение функции.

Это всегда завершится неудачей, если родительский элемент равен null.

Указано в:

getFeature в интерфейсе XMLReader

Параметры:

name - Имя функции.

Возвращает:

Текущее значение функции.

Исключения:

SAXNotRecognizedException - Если значение функции нельзя назначить или получить из родителя.

SAXNotSupportedException - Если родитель распознаёт имя функции, но не может определить её значение в данный момент.

См. также:

setProperty

public void setProperty(String name, Object value) throws SAXNotRecognizedException, SAXNotSupportedException

Установить значение свойства.

Это всегда завершится неудачей, если родительский элемент равен null.

Указано в:: setProperty в интерфейсе XMLReader
Параметры:: name - Имя свойства.; value - Запрошенное значение свойства.
Исключения:: SAXNotRecognizedException - Если значение свойства нельзя назначить или получить из родителя.; SAXNotSupportedException - Если родитель распознаёт имя свойства, но не может установить запрошенное значение.

getProperty

public Object getProperty(String name) throws SAXNotRecognizedException, SAXNotSupportedException

Получить значение свойства.

Указано в:

getProperty в интерфейсе XMLReader

Параметры:

name - Имя свойства.

Возвращает:

Текущее значение свойства.

Исключения:

SAXNotRecognizedException - Если значение свойства нельзя назначить или получить из родителя.

SAXNotSupportedException - Если родитель распознаёт имя свойства, но не может определить его значение в данный момент.

См. также:

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

Установить разрешитель сущностей.

Указано в:

setEntityResolver в интерфейсе XMLReader

Параметры:

resolver - Новый разрешитель сущностей.

См. также:

getEntityResolver

public EntityResolver getEntityResolver()

Получить текущий разрешитель сущностей.

Указано в:

getEntityResolver в интерфейсе XMLReader

Возвращает:

Текущий разрешитель сущностей или null, если он не был установлен.

См. также:

setDTDHandler

public void setDTDHandler(DTDHandler handler)

Установить обработчик событий DTD.

Указано в:

setDTDHandler в интерфейсе XMLReader

Параметры:

handler - новый обработчик DTD

См. также:

getDTDHandler

public DTDHandler getDTDHandler()

Получить текущий обработчик событий DTD.

Указано в:

getDTDHandler в интерфейсе XMLReader

Возвращает:

Текущий обработчик DTD или null, если он не был установлен.

См. также:

setContentHandler

public void setContentHandler(ContentHandler handler)

Установить обработчик событий содержимого.

Указано в:

setContentHandler в интерфейсе XMLReader

Параметры:

handler - новый обработчик содержимого

См. также:

getContentHandler

public ContentHandler getContentHandler()

Получить обработчик событий содержимого.

Указано в:

getContentHandler в интерфейсе XMLReader

Возвращает:

Текущий обработчик содержимого или null, если он не был установлен.

См. также:

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

Установить обработчик событий ошибок.

Указано в:

setErrorHandler в интерфейсе XMLReader

Параметры:

handler - новый обработчик ошибок

См. также:

getErrorHandler

public ErrorHandler getErrorHandler()

Получить текущий обработчик событий ошибок.

Указано в:

getErrorHandler в интерфейсе XMLReader

Возвращает:

Текущий обработчик ошибок или null, если он не был установлен.

См. также:

parse

public void parse(InputSource input) throws SAXException, IOException

Обработать документ.

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

parse в интерфейсе XMLReader

Параметры:

input - Источник входных данных для сущности документа.

Исключения:

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

IOException - Исключение ввода-вывода от анализатора, возможно, из байтового или символьного потока, предоставленного приложением.

См. также:

parse

public void parse(String systemId) throws SAXException, IOException

Обработать документ.

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

parse в интерфейсе XMLReader

Параметры:

systemId - Идентификатор системы в виде полностью квалифицированного URI.

Исключения:

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

См. также:

resolveEntity

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

Фильтровать разрешение внешней сущности.

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

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

Параметры:

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

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

Возвращает:

Новый InputSource или null для значения по умолчанию.

Исключения:

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

IOException - Клиент может выбросить исключение, связанное с вводом-выводом, при получении нового InputSource.

См. также:

notationDecl

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

Фильтровать событие объявления нотации.

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

notationDecl в интерфейсе DTDHandler

Параметры:

name - Имя нотации.

publicId - Открытый идентификатор нотации или null.

systemId - Системный идентификатор нотации или null.

Исключения:

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

См. также:

unparsedEntityDecl

public void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) throws SAXException

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

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

unparsedEntityDecl в интерфейсе DTDHandler

Параметры:

name - Имя сущности.

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

systemId - Системный идентификатор сущности или null.

notationName - Имя связанной нотации.

Исключения:

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

См. также:

setDocumentLocator

public void setDocumentLocator(Locator locator)

Фильтровать событие нового локатора документа.

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

setDocumentLocator в интерфейсе ContentHandler

Параметры:

locator - Локатор документа.

См. также:

startDocument

public void startDocument() throws SAXException

Фильтровать событие начала документа.

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

startDocument в интерфейсе ContentHandler

Исключения:

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

См. также:

endDocument

public void endDocument() throws SAXException

Фильтровать событие окончания документа.

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

endDocument в интерфейсе ContentHandler

Исключения:

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

См. также:

startPrefixMapping

public void startPrefixMapping(String prefix, String uri) throws SAXException

Фильтровать событие начала сопоставления префикса пространства имен.

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

startPrefixMapping в интерфейсе ContentHandler

Параметры:

prefix - Префикс пространства имен.

uri - URI пространства имен.

Исключения:

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

См. также:

endPrefixMapping

public void endPrefixMapping(String prefix) throws SAXException

Фильтровать событие окончания сопоставления префикса пространства имен.

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

endPrefixMapping в интерфейсе ContentHandler

Параметры:

prefix - Префикс пространства имен.

Исключения:

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

См. также:

startElement

public void startElement(String uri, String localName, String qName, Attributes atts) throws SAXException

Фильтровать событие начала элемента.

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

startElement в интерфейсе ContentHandler

Параметры:

uri - URI пространства имен элемента или пустая строка.

localName - Локальное имя элемента или пустая строка.

qName - Квалифицированное (с префиксом) имя элемента или пустая строка.

atts - Атрибуты элемента.

Исключения:

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

См. также:

endElement

public void endElement(String uri, String localName, String qName) throws SAXException

Фильтровать событие окончания элемента.

Определено в:: endElement в интерфейсе ContentHandler
Параметры:: uri - URI пространства имен элемента или пустая строка.; localName - Локальное имя элемента или пустая строка.; qName - Квалифицированное (с префиксом) имя элемента или пустая строка.
Исключения:: SAXException - Клиент может выбросить исключение во время обработки.

characters

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

Фильтровать событие данных символов.

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

characters в интерфейсе ContentHandler

Параметры:

ch - Массив символов.

start - Начальная позиция в массиве.

length - Количество символов для использования из массива.

Исключения:

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

См. также:

Обрабатываемое пространство

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

Фильтрация события пустого пробельного символа.

Указано:

ignorableWhitespace в интерфейсе ContentHandler

Параметры:

ch - Массив символов.

start - Начальная позиция в массиве.

length - Количество символов для использования из массива.

Исключения:

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

См. также:

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

public void processingInstruction(String target, String data) throws SAXException

Фильтрация события инструкции обработки.

Указано:: processingInstruction в интерфейсе ContentHandler
Параметры:: target - Цель инструкции обработки.; data - Текст, следующий за целью.
Исключения:: SAXException - Клиент может выбросить исключение во время обработки.

Пропущенный сущность

public void skippedEntity(String name) throws SAXException

Фильтрация события пропущенной сущности.

Указано:: skippedEntity в интерфейсе ContentHandler
Параметры:: name - Имя пропущенной сущности.
Исключения:: SAXException - Клиент может выбросить исключение во время обработки.

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

public void warning(SAXParseException e) throws SAXException

Фильтрация события предупреждения.

Указано:

warning в интерфейсе ErrorHandler

Параметры:

e - Предупреждение как исключение.

Исключения:

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

См. также:

Ошибка

public void error(SAXParseException e) throws SAXException

Фильтрация события ошибки.

Указано:

error в интерфейсе ErrorHandler

Параметры:

e - Ошибка как исключение.

Исключения:

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

См. также:

Критическая ошибка

public void fatalError(SAXParseException e) throws SAXException

Фильтрация события критической ошибки.

Указано:: fatalError в интерфейсе ErrorHandler
Параметры:: e - Ошибка как исключение.
Исключения:: SAXException - Клиент может выбросить исключение во время обработки.

© 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/helpers/XMLFilterImpl.html