Класс 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

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

См. также:

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.
https://docs.oracle.com/en/java/javase/25/docs/api/java.xml/org/xml/sax/helpers/XMLFilterImpl.html