Класс InputSource

java.lang.Object

org.xml.sax.InputSource

public class InputSource extends Object

Единственный источник ввода для XML-сущности.

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

Приложение может передать источник ввода парсеру двумя способами: в качестве аргумента методу Parser.parse или в качестве возвращаемого значения метода EntityResolver.resolveEntity.

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

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

Since:

1.4, SAX 1.0

См. также:

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

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

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

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

Методы, унаследованные от класса java.lang.Object

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

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

InputSource

public InputSource()

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

См. также:

InputSource

public InputSource(String systemId)

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

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

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

Параметры:

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

См. также:

InputSource

public InputSource(InputStream byteStream)

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

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

Параметры:

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

См. также:

InputSource

public InputSource(Reader characterStream)

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

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

Поток символов не должен содержать метку порядка байтов.

Параметры:

characterStream - поток символов

См. также:

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

setPublicId

public void setPublicId(String publicId)

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

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

Параметры:

publicId - Идентификатор публичного ключа в виде строки.

См. также:

getPublicId

public String getPublicId()

Получить идентификатор публичного ключа для данного источника ввода.

Возвращает:

Идентификатор публичного ключа или null, если он не был предоставлен.

См. также:

setSystemId

public void setSystemId(String systemId)

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

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

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

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

Параметры:

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

См. также:

getSystemId

public String getSystemId()

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

Метод getEncoding вернёт кодировку символов указанного объекта или null, если она неизвестна.

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

Возвращает:

Идентификатор системы или null, если он не был предоставлен.

См. также:

setByteStream

public void setByteStream(InputStream byteStream)

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

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

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

Параметры:

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

См. также:

getByteStream

public InputStream getByteStream()

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

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

Возвращает:

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

См. также:

setEncoding

public void setEncoding(String encoding)

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

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

Этот метод не имеет эффекта, когда приложение предоставляет поток символов.

Параметры:

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

См. также:

getEncoding

public String getEncoding()

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

Возвращает:

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

См. также:

setCharacterStream

public void setCharacterStream(Reader characterStream)

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

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

Параметры:

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

См. также:

getCharacterStream

public Reader getCharacterStream()

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

Возвращает:

Поток символов, или null, если он не был предоставлен.

См. также:

isEmpty

public boolean isEmpty()

Указывает, пуст ли объект InputSource. Пустым считается следующее:

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

В случае ошибки при проверке байтового или символьного потока метод вернет false, чтобы позволить обработчику XML обработать ошибку.

Возвращает:: true, если объект InputSource пуст, иначе false

© 1993, 2023, 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/21/docs/api/java.xml/org/xml/sax/InputSource.html