Класс XMLFilterImpl

Все реализованные интерфейсы:
ContentHandler, DTDHandler, EntityResolver, ErrorHandler, XMLFilter, XMLReader 
public class XMLFilterImpl
extends Object
implements XMLFilter, EntityResolver, DTDHandler, ContentHandler, ErrorHandler

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

Этот модуль, как исходный код, так и документация, находится в общественном достоянии и не имеет ГАРАНТИЙ. Дополнительную информацию см. на http://www.saxproject.org.

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

С тех пор:
1.4, SAX 2.0
См. также:
XMLFilter, XMLReader, EntityResolver, DTDHandler, ContentHandler, ErrorHandler

Конструкторы

Конструктор Описание
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

Конструкторы

XMLFilterImpl

public XMLFilterImpl()

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

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

См. также:
XMLReader.setFeature(java.lang.String, boolean), XMLReader.setProperty(java.lang.String, java.lang.Object), setParent(org.xml.sax.XMLReader)

XMLFilterImpl

public XMLFilterImpl(XMLReader parent)

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

См. также:
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 - Исключение ввода-вывода от парсера, возможно, из байтового или символьного потока, предоставленного приложением.
См. также:
InputSource, XMLReader.parse(java.lang.String), XMLReader.setEntityResolver(org.xml.sax.EntityResolver), XMLReader.setDTDHandler(org.xml.sax.DTDHandler), XMLReader.setContentHandler(org.xml.sax.ContentHandler), XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

parse

public void parse(String systemId)
           throws SAXException,
                  IOException

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

Указано в:
parse в интерфейсе XMLReader
Параметры:
systemId - Системный идентификатор как полностью определённый URI.
Исключения:
SAXException - Любое исключение SAX, возможно, оборачивающее другое исключение.
IOException - Исключение ввода-вывода от парсера, возможно, из байтового или символьного потока, предоставленного приложением.
См. также:
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 - Клиент может выбросить исключение во время обработки.
См. также:
DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String), Attributes

unparsedEntityDecl

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

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

Указано:
unparsedEntityDecl в интерфейсе DTDHandler
Параметры:
name - Имя сущности.
publicId - Открытый идентификатор сущности или null.
systemId - Системный идентификатор сущности или null.
notationName - Имя связанной нотации.
Исключения:
SAXException - Клиент может бросить исключение во время обработки.
См. также:
DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String), Attributes

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 - Клиент может бросить исключение во время обработки.
См. также:
ContentHandler.endPrefixMapping(java.lang.String), ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

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

Указано:
endPrefixMapping в интерфейсе ContentHandler
Параметры:
prefix - Префикс пространства имен.
Исключения:
SAXException - Клиент может бросить исключение во время обработки.
См. также:
ContentHandler.startPrefixMapping(java.lang.String, java.lang.String), ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

startElement

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

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

Указано:
startElement в интерфейсе ContentHandler
Параметры:
uri - URI пространства имен элемента или пустая строка.
localName - Локальное имя элемента или пустая строка.
qName - Квалифицированное (с префиксом) имя элемента или пустая строка.
atts - Атрибуты элемента.
Исключения:
SAXException - Клиент может бросить исключение во время обработки.
См. также:
ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String), Attributes, AttributesImpl

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 - Клиент может бросить исключение во время обработки.
См. также:
ContentHandler.ignorableWhitespace(char[], int, int), Locator

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

warning

public void warning(SAXParseException e)
             throws SAXException

Отфильтровать событие предупреждения.

Указано:
warning в интерфейсе ErrorHandler
Параметры:
e - Предупреждение как исключение.
Исключения:
SAXException - Клиент может бросить исключение во время обработки.
См. также:
SAXParseException

error

public void error(SAXParseException e)
           throws SAXException

Отфильтровать событие ошибки.

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

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

Отфильтровать событие критической ошибки.

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

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

Spec-Zone .ru
спецификации, руководства, описания, API