Класс SAXParser

public abstract class SAXParser
extends Object

Определяет API, который оборачивает класс реализации XMLReader. В JAXP 1.0 этот класс оборачивал интерфейс Parser, однако этот интерфейс был заменён на XMLReader. Для упрощения перехода этот класс продолжает поддерживать то же имя и интерфейс, а также новые методы. Экземпляр этого класса можно получить из метода SAXParserFactory.newSAXParser(). После получения экземпляра этого класса XML можно анализировать из различных источников ввода. Эти источники ввода — это InputStream, файлы, URL-адреса и SAX InputSources.

Этот статический метод создаёт новый экземпляр фабрики на основе настройки системной переменной или использует платформенный стандарт, если переменная не определена.

Системная переменная, которая управляет тем, какую реализацию фабрики создать, называется "javax.xml.parsers.SAXParserFactory". Эта переменная задаёт имя класса, который является конкретным подклассом этого абстрактного класса. Если переменная не определена, будет использоваться платформенный стандарт.

При анализе содержимого базовым анализатором вызываются методы заданного HandlerBase или DefaultHandler.

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

Краткое описание конструкторов

SAXParser

protected SAXParser()

Краткое описание методов

reset

public void reset()

Исключения:

UnsupportedOperationException - Когда реализации не переопределяют этот метод

С версии:

1.5

parse

public void parse(InputStream is,
                  HandlerBase hb)
           throws SAXException,
                  IOException

Параметры:

is - InputStream, содержащий содержимое для разбора.

hb - SAX HandlerBase для использования.

Исключения:

IllegalArgumentException - Если данный InputStream равен null.

SAXException - Если разбор создаёт ошибку SAX.

IOException - Если возникает ошибка ввода-вывода при взаимодействии с InputStream.

См. также:

DocumentHandler

parse

public void parse(InputStream is,
                  HandlerBase hb,
                  String systemId)
           throws SAXException,
                  IOException

Параметры:

is - InputStream, содержащий содержимое для разбора.

hb - SAX HandlerBase для использования.

systemId - systemId, необходимый для разрешения относительных URI.

Исключения:

IllegalArgumentException - Если данный InputStream является null.

IOException - Если возникает ошибка ввода-вывода при взаимодействии с InputStream.

SAXException - Если во время обработки возникают ошибки SAX.

См. также:

version of this method instead.

parse

public void parse(InputStream is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException

Разбор содержимого данного экземпляра InputStream как XML с использованием указанного DefaultHandler.

Параметры:

is - InputStream, содержащий содержимое для разбора.

dh - SAX DefaultHandler для использования.

Исключения:

IllegalArgumentException - Если данный InputStream равен null.

IOException - Если возникают ошибки ввода-вывода.

SAXException - Если во время обработки возникают ошибки SAX.

См. также:

DocumentHandler

parse

public void parse(InputStream is,
                  DefaultHandler dh,
                  String systemId)
           throws SAXException,
                  IOException

Разбор содержимого данного экземпляра InputStream как XML с использованием указанного DefaultHandler.

Параметры:

is - InputStream, содержащий содержимое для разбора.

dh - SAX DefaultHandler для использования.

systemId - systemId, необходимый для разрешения относительных URI.

Исключения:

IllegalArgumentException - Если данный InputStream равен null.

IOException - Если возникают ошибки ввода-вывода.

SAXException - Если во время обработки возникают ошибки SAX.

См. также:

version of this method instead.

parse

public void parse(String uri,
                  HandlerBase hb)
           throws SAXException,
                  IOException

Разбор содержимого, описанного данным универсальным идентификатором ресурса (URI), как XML с использованием указанного HandlerBase. Рекомендуется использовать версию этого метода с DefaultHandler, поскольку класс HandlerBase был устаревшим в SAX 2.0

Параметры:

uri - Расположение содержимого для разбора.

hb - SAX HandlerBase для использования.

Исключения:

IllegalArgumentException - Если uri равен null.

IOException - Если возникают ошибки ввода-вывода.

SAXException - Если во время обработки возникают ошибки SAX.

См. также:

DocumentHandler

parse

public void parse(String uri,
                  DefaultHandler dh)
           throws SAXException,
                  IOException

Разбор содержимого, описанного данным универсальным идентификатором ресурса (URI), как XML с использованием указанного DefaultHandler.

Параметры:

uri - Расположение содержимого для разбора.

dh - SAX DefaultHandler для использования.

Исключения:

IllegalArgumentException - Если uri равен null.

IOException - Если возникают ошибки ввода-вывода.

SAXException - Если во время обработки возникают ошибки SAX.

См. также:

DocumentHandler

parse

public void parse(File f,
                  HandlerBase hb)
           throws SAXException,
                  IOException

Разбор содержимого указанного файла как XML с использованием указанного HandlerBase. Рекомендуется использовать версию этого метода с DefaultHandler, поскольку класс HandlerBase был устаревшим в SAX 2.0

Параметры:

f - Файл, содержащий XML для разбора

hb - SAX HandlerBase для использования.

Исключения:

IllegalArgumentException - Если объект File равен null.

IOException - Если возникают ошибки ввода-вывода.

SAXException - Если во время обработки возникают ошибки SAX.

См. также:

DocumentHandler

parse

public void parse(File f,
                  DefaultHandler dh)
           throws SAXException,
                  IOException

Разбор содержимого указанного файла как XML с использованием указанного DefaultHandler.

Параметры:

f - Файл, содержащий XML для разбора

dh - SAX DefaultHandler для использования.

Исключения:

IllegalArgumentException - Если объект File равен null.

IOException - Если возникают ошибки ввода-вывода.

SAXException - Если во время обработки возникают ошибки SAX.

См. также:

DocumentHandler

parse

public void parse(InputSource is,
                  HandlerBase hb)
           throws SAXException,
                  IOException

Разбор данного InputSource как XML с использованием указанного HandlerBase. Рекомендуется использовать версию этого метода с DefaultHandler, поскольку класс HandlerBase был устаревшим в SAX 2.0

Параметры:

is - InputSource, содержащий содержимое для разбора.

hb - SAX HandlerBase для использования.

Исключения:

IllegalArgumentException - Если объект InputSource является null.

IOException - Если возникают ошибки ввода-вывода.

SAXException - Если во время обработки возникают ошибки SAX.

См. также:

DocumentHandler

parse

public void parse(InputSource is,
                  DefaultHandler dh)
           throws SAXException,
                  IOException

Разбор данного InputSource как XML с использованием указанного DefaultHandler.

Параметры:

is - InputSource, содержащий содержимое для разбора.

dh - SAX DefaultHandler для использования.

Исключения:

IllegalArgumentException - Если объект InputSource является null.

IOException - Если возникают ошибки ввода-вывода.

SAXException - Если во время обработки возникают ошибки SAX.

См. также:

DocumentHandler

getParser

public abstract Parser getParser()
                          throws SAXException

Возвращает SAX-парсер, инкапсулированный реализацией этого класса.

Возвращает:

SAX-парсер, инкапсулированный реализацией этого класса.

Исключения:

SAXException - Если во время обработки возникают ошибки SAX.

getXMLReader

public abstract XMLReader getXMLReader()
                                throws SAXException

Возвращает XMLReader, инкапсулированный реализацией этого класса.

Возвращает:

XMLReader, инкапсулированный реализацией этого класса.

Исключения:

SAXException - Если во время обработки возникают ошибки SAX.

isNamespaceAware

public abstract boolean isNamespaceAware()

Указывает, настроен ли этот парсер на понимание пространств имён.

Возвращает:

true, если этот парсер настроен на понимание пространств имён; false в противном случае.

isValidating

public abstract boolean isValidating()

Указывает, настроена ли эта разборная программа для проверки XML-документов.

Возвращает:

true, если эта разборная программа настроена для проверки XML-документов; иначе — false.

setProperty

public abstract void setProperty(String name,
                                 Object value)
                          throws SAXNotRecognizedException,
                                 SAXNotSupportedException

Параметры:

name - Имя свойства, которое нужно установить.

value - Значение свойства, которое нужно установить.

Исключения:

SAXNotRecognizedException - Когда базовый XMLReader не распознаёт имя свойства.

SAXNotSupportedException - Когда базовый XMLReader распознаёт имя свойства, но не поддерживает это свойство.

См. также:

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

getProperty

public abstract Object getProperty(String name)
                            throws SAXNotRecognizedException,
                                   SAXNotSupportedException

Параметры:

name - Имя свойства, которое нужно получить.

Возвращает:

Значение запрошенного свойства.

Исключения:

SAXNotRecognizedException - Когда базовый XMLReader не распознаёт имя свойства.

SAXNotSupportedException - Когда базовый XMLReader распознаёт имя свойства, но не поддерживает это свойство.

См. также:

XMLReader.getProperty(java.lang.String)

getSchema

public Schema getSchema()

Возвращает:

Schema, используемую, или null, если не используется

Исключения:

UnsupportedOperationException - Когда реализация не переопределяет этот метод

См.:

1.5

isXIncludeAware

public boolean isXIncludeAware()

Возвращает:

Значение возвращаемого значения SAXParserFactory.isXIncludeAware(), когда этот разбор был создан из фабрики.

Исключения:

UnsupportedOperationException - Когда реализация не переопределяет этот метод

См.:

1.5

См. также:

SAXParserFactory.setXIncludeAware(boolean)