Класс 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(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)`	Задает общедоступный идентификатор для этого Source.
`void`	`setReader(Reader reader)`	Задает в качестве входных данных символьный считыватель.
`void`	`setSystemId(File f)`	Задает системный идентификатор на основе ссылки на файл.
`void`	`setSystemId(String systemId)`	Задает системный идентификатор для этого Source.

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

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

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

FEATURE

public static final String FEATURE

Если TransformerFactory.getFeature(String) возвращает true при передаче этого значения в качестве аргумента, Transformer поддерживает входные данные 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 - Должна быть ненулевая ссылка 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)

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

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

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

getPublicId

public String getPublicId()

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

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

setSystemId

public void setSystemId(String systemId)

Задает системный идентификатор для этого Source.

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

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

getSystemId

public String getSystemId()

Возвращает системный идентификатор, заданный с помощью setSystemId.

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

setSystemId

public void setSystemId(File f)

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

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

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://docs.oracle.com/en/java/javase/25/docs/api/java.xml/javax/xml/transform/stream/StreamSource.html