Класс 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)`	Фильтрует событие предупреждения.

Методы, объявленные в классе Object

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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Проверяет, равен ли этот объект другому объекту.
`protected void`	`finalize()`	Устарело и будет удалено: этот элемент API может быть удален в будущей версии. Финализация объявлена устаревшей и подлежит удалению в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает хеш-код этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt.
`final void`	`wait(long timeoutMillis)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения заданного промежутка времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо истечения заданного промежутка времени.

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

declaration

Модификатор и тип	Метод	Описание
`default void`	`declaration(String version, String encoding, String standalone)`	Получает уведомление об объявлении XML.

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

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 — клиент может выбросить исключение во время обработки.

См. также:

ignorableWhitespace

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

Фильтрует событие незначащих пробельных символов.

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

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

Параметры:

ch — массив символов.

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

length — количество символов, используемых из массива.

Вызывает исключения:

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

См. также:

processingInstruction

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

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

Определено в:: processingInstruction в интерфейсе ContentHandler
Параметры:: target — цель инструкции обработки.; data — текст, следующий за целью.
Вызывает исключения:: SAXException — клиент может выбросить исключение во время обработки.

skippedEntity

public void skippedEntity(String name) throws SAXException

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

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

warning

public void warning(SAXParseException e) throws SAXException

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

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

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

Параметры:

e — предупреждение в виде исключения.

Вызывает исключения:

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

См. также:

error

public void error(SAXParseException e) throws SAXException

Фильтрует событие ошибки.

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

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

Параметры:

e — ошибка в виде исключения.

Вызывает исключения:

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

См. также:

fatalError

public void fatalError(SAXParseException e) throws SAXException

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

Определено в:: fatalError в интерфейсе ErrorHandler
Параметры:: e — ошибка в виде исключения.
Вызывает исключения:: SAXException — клиент может выбросить исключение во время обработки.

© 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.