Класс 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(org.xml.sax.XMLReader)
getParent()

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

setParent

public void setParent(XMLReader parent)

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

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

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

Установлено в:

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

Параметры:

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

См. также:

getParent()

getParent

public XMLReader getParent()

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

Установлено в:

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

Возвращает:

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

См. также:

setParent(org.xml.sax.XMLReader)

setFeature

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

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

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

Установлено в:

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

Параметры:

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

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

Исключения:

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

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

См. также:

XMLReader.getFeature(java.lang.String)

getFeature

public boolean getFeature(String name) throws SAXNotRecognizedException, SAXNotSupportedException

Поиск значения функции.

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

Установлено в:

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

Параметры:

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

Возвращает:

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

Исключения:

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

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

См. также:

XMLReader.setFeature(java.lang.String, boolean)

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 - Когда родитель распознаёт имя свойства, но не может определить его значение в данный момент.

См. также:

XMLReader.setProperty(java.lang.String, java.lang.Object)

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

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

Установлено в:

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

Параметры:

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

См. также:

XMLReader.getEntityResolver()

getEntityResolver

public EntityResolver getEntityResolver()

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

Установлено в:

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

Возвращает:

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

См. также:

XMLReader.setEntityResolver(org.xml.sax.EntityResolver)

setDTDHandler

public void setDTDHandler(DTDHandler handler)

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

Установлено в:

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

Параметры:

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

См. также:

XMLReader.getDTDHandler()

getDTDHandler

public DTDHandler getDTDHandler()

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

Установлено в:

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

Возвращает:

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

См. также:

XMLReader.setDTDHandler(org.xml.sax.DTDHandler)

setContentHandler

public void setContentHandler(ContentHandler handler)

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

Установлено в:

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

Параметры:

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

См. также:

XMLReader.getContentHandler()

getContentHandler

public ContentHandler getContentHandler()

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

Установлено в:

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

Возвращает:

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

См. также:

XMLReader.setContentHandler(org.xml.sax.ContentHandler)

setErrorHandler

public void setErrorHandler(ErrorHandler handler)

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

Установлено в:

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

Параметры:

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

См. также:

XMLReader.getErrorHandler()

getErrorHandler

public ErrorHandler getErrorHandler()

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

Установлено в:

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

Возвращает:

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

См. также:

XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

parse

public void parse(InputSource input) throws SAXException, IOException

Разбор документа.

Установлено в:

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

Параметры:

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

Исключения:

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

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

См. также:

parse

public void parse(String systemId) throws SAXException, IOException

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

Указано в:

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

Параметры:

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

Исключения:

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

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

См. также:

XMLReader.parse(org.xml.sax.InputSource)

resolveEntity

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

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

Указано в:

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

Параметры:

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

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

Возвращает:

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

Исключения:

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

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

См. также:

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 - Локетор документа.

См. также:

Locator

startDocument

public void startDocument() throws SAXException

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

Указано в:

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

Исключения:

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

См. также:

ContentHandler.endDocument()

endDocument

public void endDocument() throws SAXException

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

Указано в:

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

Исключения:

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

См. также:

ContentHandler.startDocument()

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

См. также:

ContentHandler.characters(char[], int, int)

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

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

public void warning(SAXParseException e) throws SAXException

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

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

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

Параметры:

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

Исключения:

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

См. также:

SAXParseException

Ошибка

public void error(SAXParseException e) throws SAXException

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

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

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

Параметры:

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

Исключения:

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

См. также:

SAXParseException

fatalError

public void fatalError(SAXParseException e) throws SAXException

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

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

© 1993, 2021, 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/17/docs/api/java.xml/org/xml/sax/helpers/XMLFilterImpl.html