Spec-Zone.ru › OpenJDK 24

Класс 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
См. также:
  • 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

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

declaration

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

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 с указанным родителем.
Параметры:
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
Получить значение свойства.
Specified by:
getProperty in interface XMLReader
Parameters:
name - Имя свойства.
Returns:
Текущее значение свойства.
Throws:
SAXNotRecognizedException - Если значение свойства нельзя присвоить или получить из родителя.
SAXNotSupportedException - Когда родитель распознаёт имя свойства, но не может определить его значение в данный момент.
See Also:
  • XMLReader.setProperty(java.lang.String, java.lang.Object)

setEntityResolver

public void setEntityResolver(EntityResolver resolver)
Установить обработчик сущностей.
Specified by:
setEntityResolver in interface XMLReader
Parameters:
resolver - Новый обработчик сущностей.
See Also:
  • XMLReader.getEntityResolver()

getEntityResolver

public EntityResolver getEntityResolver()
Получить текущий обработчик сущностей.
Specified by:
getEntityResolver in interface XMLReader
Returns:
Текущий обработчик сущностей или null, если он не был установлен.
See Also:
  • XMLReader.setEntityResolver(org.xml.sax.EntityResolver)

setDTDHandler

public void setDTDHandler(DTDHandler handler)
Установить обработчик событий DTD.
Specified by:
setDTDHandler in interface XMLReader
Parameters:
handler - новый обработчик DTD
See Also:
  • XMLReader.getDTDHandler()

getDTDHandler

public DTDHandler getDTDHandler()
Получить текущий обработчик событий DTD.
Specified by:
getDTDHandler in interface XMLReader
Returns:
Текущий обработчик DTD или null, если он не был установлен.
See Also:
  • XMLReader.setDTDHandler(org.xml.sax.DTDHandler)

setContentHandler

public void setContentHandler(ContentHandler handler)
Установить обработчик событий содержимого.
Specified by:
setContentHandler in interface XMLReader
Parameters:
handler - новый обработчик содержимого
See Also:
  • XMLReader.getContentHandler()

getContentHandler

public ContentHandler getContentHandler()
Получить текущий обработчик событий содержимого.
Specified by:
getContentHandler in interface XMLReader
Returns:
Текущий обработчик содержимого или null, если он не был установлен.
See Also:
  • XMLReader.setContentHandler(org.xml.sax.ContentHandler)

setErrorHandler

public void setErrorHandler(ErrorHandler handler)
Установить обработчик ошибок.
Specified by:
setErrorHandler in interface XMLReader
Parameters:
handler - новый обработчик ошибок
See Also:
  • XMLReader.getErrorHandler()

getErrorHandler

public ErrorHandler getErrorHandler()
Получить текущий обработчик ошибок.
Specified by:
getErrorHandler in interface XMLReader
Returns:
Текущий обработчик ошибок или null, если он не был установлен.
See Also:
  • XMLReader.setErrorHandler(org.xml.sax.ErrorHandler)

Разбор

public void parse(InputSource input) throws SAXException, IOException
Разбор документа.
Определено в:
parse в интерфейсе XMLReader
Параметры:
input - Источник входных данных для сущности документа.
Исключения:
SAXException - Любое исключение SAX, возможно, обертывающее другое исключение.
IOException - Исключение IO от анализатора, возможно, из потока байтов или потока символов, предоставленного приложением.
См. также:
  • 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)

Разбор

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

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

© 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://download.java.net/java/early_access/jdk24/docs/api/java.xml/org/xml/sax/helpers/XMLFilterImpl.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API