Класс 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 поддерживает входной источник данного типа.

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

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

См. также:

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

StreamSource

public StreamSource()

Конструктор по умолчанию без аргументов. Если этот конструктор используется, и никакой источник Stream не установлен с помощью 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, 2025, 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://download.java.net/java/early_access/jdk24/docs/api/java.xml/javax/xml/transform/stream/StreamSource.html