org.xml.sax

Класс InputSource

java.lang. Объект

org.xml.sax. InputSource

public class InputSource
extends Object

Единственный входной источник для объекта XML.

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

Этот класс позволяет приложению SAX инкапсулировать информацию о входном источнике в единственном объекте, который может включать общедоступный идентификатор, системный идентификатор, поток байтов (возможно с указанным кодированием), и/или символьный поток.

Есть два места, что приложение может поставить входной источник синтаксическому анализатору: как параметр методу Parser.parse, или как возвращаемое значение метода EntityResolver.resolveEntity.

Синтаксический анализатор SAX будет использовать объект InputSource определить, как считать ввод XML. Если будет символьный доступный поток, то синтаксический анализатор считает тот поток непосредственно, игнорируя любой текст, кодирующий объявление, найденное в том потоке. Если не будет никакого символьного потока, но есть поток байтов, то синтаксический анализатор будет использовать тот поток байтов, используя кодирование, определенное в InputSource или иначе (если никакое кодирование не будет определено), автоматическое обнаружение кодировки символов, используя алгоритм, такой как тот в спецификации XML. Если ни символьный поток, ни поток байтов не будут доступны, то синтаксический анализатор попытается открыть соединение URI с ресурсом, идентифицированным системным идентификатором.

Объект InputSource принадлежит приложению: синтаксический анализатор SAX никогда не должен изменять это всегда (это может изменить копию в случае необходимости). Однако, стандартная обработка и байта и символьных потоков должна закрыть их на как часть уборки конца синтаксического анализа, таким образом, приложения не должны попытаться снова использовать такие потоки после того, как их вручили синтаксическому анализатору.

С тех пор:

SAX 1.0

См. Также:

XMLReader.parse(org.xml.sax.InputSource), EntityResolver.resolveEntity(java.lang.String, java.lang.String), InputStream, Reader

Сводка конструктора

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

Конструктор и Описание
InputSource() Конструктор по умолчанию нулевого параметра.
InputSource(InputStream byteStream) Создайте новый входной источник с потоком байтов.
InputSource(Reader characterStream) Создайте новый входной источник с символьным потоком.
InputSource(String systemId) Создайте новый входной источник с системным идентификатором.

Сводка метода

Методы

Модификатор и Тип	Метод и Описание
InputStream	getByteStream() Получите поток байтов для этого входного источника.
Читатель	getCharacterStream() Получите символьный поток для этого входного источника.
Строка	getEncoding() Получите кодировку символов для потока байтов или URI.
Строка	getPublicId() Получите общедоступный идентификатор для этого входного источника.
Строка	getSystemId() Получите системный идентификатор для этого входного источника.
void	setByteStream(InputStream byteStream) Установите поток байтов для этого входного источника.
void	setCharacterStream(Reader characterStream) Установите символьный поток для этого входного источника.
void	setEncoding(String encoding) Установите кодировку символов, если известный.
void	setPublicId(String publicId) Установите общедоступный идентификатор для этого входного источника.
void	setSystemId(String systemId) Установите системный идентификатор для этого входного источника.

Методы java.lang унаследованный от класса. Объект

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Деталь конструктора

InputSource

public InputSource()

Конструктор по умолчанию нулевого параметра.

См. Также:

setPublicId(java.lang.String), setSystemId(java.lang.String), setByteStream(java.io.InputStream), setCharacterStream(java.io.Reader), setEncoding(java.lang.String)

InputSource

public InputSource(String systemId)

Создайте новый входной источник с системным идентификатором.

Приложения могут использовать setPublicId, чтобы включать общедоступный идентификатор также, или setEncoding, чтобы определить кодировку символов, если известный.

Если системным идентификатором является URL, он должен быть полностью разрешен (это, возможно, не относительный URL).

Параметры:

systemId - Системный идентификатор (URI).

См. Также:

setPublicId(java.lang.String), setSystemId(java.lang.String), setByteStream(java.io.InputStream), setEncoding(java.lang.String), setCharacterStream(java.io.Reader)

InputSource

public InputSource(InputStream byteStream)

Создайте новый входной источник с потоком байтов.

Писатели приложения должны использовать setSystemId (), чтобы обеспечить основу для того, чтобы она разрешила относительные URI, могут использовать setPublicId, чтобы включать общедоступный идентификатор, и могут использовать setEncoding, чтобы определить кодировку символов объекта.

Параметры:

byteStream - Необработанный поток байтов, содержащий документ.

См. Также:

setPublicId(java.lang.String), setSystemId(java.lang.String), setEncoding(java.lang.String), setByteStream(java.io.InputStream), setCharacterStream(java.io.Reader)

InputSource

public InputSource(Reader characterStream)

Создайте новый входной источник с символьным потоком.

Писатели приложения должны использовать setSystemId (), чтобы обеспечить основу для того, чтобы она разрешила относительные URI, и могут использовать setPublicId, чтобы включать общедоступный идентификатор.

Символьный поток не должен включать метку порядка байтов.

См. Также:

setPublicId(java.lang.String), setSystemId(java.lang.String), setByteStream(java.io.InputStream), setCharacterStream(java.io.Reader)

Деталь метода

setPublicId

public void setPublicId(String publicId)

Установите общедоступный идентификатор для этого входного источника.

Общедоступный идентификатор является всегда дополнительным: если писатель приложения будет включать один, то это будет обеспечено как часть информации о расположении.

Параметры:

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

См. Также:

getPublicId(), Locator.getPublicId(), SAXParseException.getPublicId()

getPublicId

public String getPublicId()

Получите общедоступный идентификатор для этого входного источника.

Возвраты:

Общедоступный идентификатор, или нуль, если ни один не был предоставлен.

См. Также:

setPublicId(java.lang.String)

setSystemId

public void setSystemId(String systemId)

Установите системный идентификатор для этого входного источника.

Системный идентификатор является дополнительным, если есть поток байтов или символьный поток, но все еще полезно обеспечить один, так как приложение может использовать это, чтобы разрешить относительные URI и может включать это в сообщения об ошибках, и предупреждения (синтаксический анализатор попытается открыть соединение с URI, только если нет никакого потока байтов или символьного определенного потока).

Если приложение знает кодировку символов объекта, на который указывает системный идентификатор, это может зарегистрировать кодирование, используя setEncoding метод.

Если системным идентификатором является URL, он должен быть полностью разрешен (это, возможно, не относительный URL).

Параметры:

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

См. Также:

setEncoding(java.lang.String), getSystemId(), Locator.getSystemId(), SAXParseException.getSystemId()

getSystemId

public String getSystemId()

Получите системный идентификатор для этого входного источника.

getEncoding метод возвратит кодировку символов объекта, на который указывают, или нуль если неизвестный.

Если системным ID будет URL, то он будет полностью разрешен.

Возвраты:

Системный идентификатор, или нуль, если ни один не был предоставлен.

См. Также:

setSystemId(java.lang.String), getEncoding()

setByteStream

public void setByteStream(InputStream byteStream)

Установите поток байтов для этого входного источника.

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

Если приложение знает кодировку символов потока байтов, это должно установить это с setEncoding методом.

Параметры:

byteStream - Поток байтов, содержащий XML-документ или другой объект.

См. Также:

setEncoding(java.lang.String), getByteStream(), getEncoding(), InputStream

getByteStream

public InputStream getByteStream()

Получите поток байтов для этого входного источника.

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

Возвраты:

Поток байтов, или нуль, если ни один не был предоставлен.

См. Также:

getEncoding(), setByteStream(java.io.InputStream)

setEncoding

public void setEncoding(String encoding)

Установите кодировку символов, если известный.

Кодирование должно быть строкой, приемлемой для XML, кодирующего объявление (см. раздел 4.3.3 из рекомендации XML 1.0).

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

Параметры:

encoding - Строка, описывающая кодировку символов.

См. Также:

setSystemId(java.lang.String), setByteStream(java.io.InputStream), getEncoding()

getEncoding

public String getEncoding()

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

Возвраты:

Кодирование, или нуль, если ни один не был предоставлен.

См. Также:

setByteStream(java.io.InputStream), getSystemId(), getByteStream()

setCharacterStream

public void setCharacterStream(Reader characterStream)

Установите символьный поток для этого входного источника.

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

Параметры:

characterStream - Символьный поток, содержащий XML-документ или другой объект.

См. Также:

getCharacterStream(), Reader

getCharacterStream

public Reader getCharacterStream()

Получите символьный поток для этого входного источника.

Возвраты:

Символьный поток, или нуль, если ни один не был предоставлен.

См. Также:

setCharacterStream(java.io.Reader)