Класс StreamSource

java.lang.Object

javax.xml.transform.stream.StreamSource

Все реализованные интерфейсы:: Source

public class StreamSource extends Object implements Source

Выступает в роли держателя источника преобразования в виде потока XML-разметки.

Примечание: из-за внутреннего использования экземпляра Reader или InputStream, экземпляры StreamSource могут быть использованы только один раз.

С момента:: 1.4

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final String`	`FEATURE`	Если `TransformerFactory.getFeature(java.lang.String)` возвращает true при передаче этого значения в качестве аргумента, преобразователь поддерживает входной источник данного типа.

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

Конструктор	Описание
`StreamSource()`	Конструктор по умолчанию без аргументов.
`StreamSource(File f)`	Создает StreamSource из файла.
`StreamSource(InputStream inputStream)`	Создает StreamSource из потока байтов.
`StreamSource(InputStream inputStream, String systemId)`	Создает StreamSource из потока байтов.
`StreamSource(Reader reader)`	Создает StreamSource из потока символов.
`StreamSource(Reader reader, String systemId)`	Создает StreamSource из потока символов.
`StreamSource(String systemId)`	Создает StreamSource из URL.

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

Модификатор и тип	Метод	Описание
`InputStream`	`getInputStream()`	Получить поток байтов, установленный с помощью setByteStream.
`String`	`getPublicId()`	Получить общедоступный идентификатор, установленный с помощью setPublicId.
`Reader`	`getReader()`	Получить поток символов, установленный с помощью setReader.
`String`	`getSystemId()`	Получить системный идентификатор, установленный с помощью setSystemId.
`boolean`	`isEmpty()`	Указывает, пуст ли объект `StreamSource`.
`void`	`setInputStream(InputStream inputStream)`	Установить поток байтов для использования в качестве входных данных.
`void`	`setPublicId(String publicId)`	Установить общедоступный идентификатор для этого источника.
`void`	`setReader(Reader reader)`	Установить ввод в виде потока символов.
`void`	`setSystemId(File f)`	Установить системный идентификатор из ссылки на файл.
`void`	`setSystemId(String systemId)`	Установить системный идентификатор для этого источника.

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

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

Подробное описание полей

FEATURE

public static final String FEATURE

Если TransformerFactory.getFeature(java.lang.String) возвращает true при передаче этого значения в качестве аргумента, трансформатор поддерживает исходный ввод этого типа.

См. также:

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

StreamSource

public StreamSource()

Конструктор по умолчанию без аргументов. Если используется этот конструктор и источник потока не задан с помощью setInputStream(java.io.InputStream inputStream) или setReader(java.io.Reader reader), то Transformer создаст пустой источник InputStream с помощью new InputStream().

См. также:

StreamSource

public StreamSource(InputStream inputStream)

Создаёт StreamSource из потока байтов. Обычно следует использовать поток, а не ридер, чтобы парсер XML мог разрешить кодировку символов, указанную в декларации XML.

Если этот конструктор используется для обработки стилей, обычно необходимо также вызвать setSystemId, чтобы можно было разрешить ссылки на относительные URI.

Параметры:: inputStream - Действительная ссылка на InputStream для потока XML.

StreamSource

public StreamSource(InputStream inputStream, String systemId)

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

Параметры:: inputStream - Действительная ссылка на InputStream для потока XML.; systemId - Должен быть строкой, соответствующей синтаксису URI.

StreamSource

public StreamSource(Reader reader)

Создаёт StreamSource из ридера символов. Обычно следует использовать поток, а не ридер, чтобы парсер XML мог разрешить кодировку символов, указанную в декларации XML. Однако во многих случаях кодировка входного потока уже определена, как в случае чтения XML из StringReader.

Параметры:: reader - Действительная ссылка на Reader для потока XML символов.

StreamSource

public StreamSource(Reader reader, String systemId)

Параметры:: reader - Действительная ссылка на Reader для потока XML символов.; systemId - Должен быть строкой, соответствующей синтаксису URI.

StreamSource

public StreamSource(String systemId)

Создаёт StreamSource из URL.

Параметры:: systemId - Должен быть строкой, соответствующей синтаксису URI.

StreamSource

public StreamSource(File f)

Создаёт StreamSource из файла.

Параметры:: f - Должна быть ссылка на непустой файл.

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

setInputStream

public void setInputStream(InputStream inputStream)

Устанавливает поток байтов, используемый в качестве входных данных. Обычно следует использовать поток, а не ридер, чтобы парсер XML мог разрешить кодировку символов, указанную в декларации XML.

Если этот объект Source используется для обработки стилей, обычно необходимо также вызвать setSystemId, чтобы разрешить ссылки на относительные URL.

Параметры:: inputStream - Действительная ссылка на InputStream для потока XML.

getInputStream

public InputStream getInputStream()

Получает поток байтов, установленный с помощью setByteStream.

Возвращает:: Поток байтов, установленный с помощью setByteStream, или null, если setByteStream или конструктор ByteStream не вызывались.

setReader

public void setReader(Reader reader)

Устанавливает входной поток в виде ридера символов. Обычно следует использовать поток, а не ридер, чтобы парсер XML мог разрешить кодировку символов, указанную в декларации XML. Однако во многих случаях кодировка входного потока уже определена, как в случае чтения XML из StringReader.

Параметры:: reader - Действительная ссылка на Reader для потока XML символов.

getReader

public Reader getReader()

Получает поток символов, установленный с помощью setReader.

Возвращает:: Поток символов, установленный с помощью setReader, или null, если setReader или конструктор Reader не вызывались.

setPublicId

public void setPublicId(String publicId)

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

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

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

getPublicId

public String getPublicId()

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

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

setSystemId

public void setSystemId(String systemId)

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

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

Указано в:: setSystemId в интерфейсе Source
Параметры:: systemId - Системный идентификатор в виде строки URL.

getSystemId

public String getSystemId()

Получает системный идентификатор, установленный с помощью setSystemId.

Указано в:: getSystemId в интерфейсе Source
Возвращает:: Системный идентификатор, установленный с помощью setSystemId, или null, если setSystemId не вызывался.

setSystemId

public void setSystemId(File f)

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

Параметры:: f - Должна быть ссылка на непустой файл.

isEmpty

public boolean isEmpty()

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

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

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

Указано в:: isEmpty в интерфейсе Source
Возвращает:: true, если объект StreamSource пустой, иначе 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/javax/xml/transform/stream/StreamSource.html