Класс 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, когда этот параметр передается в качестве аргумента, Transformer поддерживает ввод Source этого типа.

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

Конструктор	Описание
`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 при передаче этого значения в качестве аргумента, то Transformer поддерживает входной тип Source.

См. также:

Значения константных полей

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

StreamSource

public StreamSource()

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

См. также:

Transformer.transform(Source xmlSource, Result outputTarget)

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 - Должен быть ссылкой на непустой File.

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

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)

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

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

Параметры:: publicId - Идентификатор public в виде строки.

getPublicId

public String getPublicId()

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

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

setSystemId

public void setSystemId(String systemId)

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

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

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

getSystemId

public String getSystemId()

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

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

setSystemId

public void setSystemId(File f)

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

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

isEmpty

public boolean isEmpty()

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

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

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

Указано в:: isEmpty в интерфейсе Source
Возвращает:: true, если объект StreamSource пустой, иначе false

© 1993, 2021, 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/17/docs/api/java.xml/javax/xml/transform/stream/StreamSource.html