Класс 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 при передаче этого значения в качестве аргумента, преобразователь поддерживает входные данные 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

Модификатор и тип	Метод	Описание
`protected Object`	`clone()`	Создает и возвращает копию этого объекта.
`boolean`	`equals(Object obj)`	Указывает, равен ли этот объект другому объекту.
`protected void`	`finalize()`	Устарело, будет удалено: этот элемент API может быть удален в будущей версии. Финализация объявлена устаревшей и будет удалена в одном из будущих выпусков.
`final Class<?>`	`getClass()`	Возвращает класс времени выполнения этого `Object`.
`int`	`hashCode()`	Возвращает значение хеш-кода для этого объекта.
`final void`	`notify()`	Пробуждает один поток, ожидающий на мониторе этого объекта.
`final void`	`notifyAll()`	Пробуждает все потоки, ожидающие на мониторе этого объекта.
`String`	`toString()`	Возвращает строковое представление объекта.
`final void`	`wait()`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания.
`final void`	`wait(long timeoutMillis)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.
`final void`	`wait(long timeoutMillis, int nanos)`	Переводит текущий поток в состояние ожидания до его пробуждения, обычно посредством уведомления или прерывания, либо до истечения заданного промежутка реального времени.

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

FEATURE

public static final String FEATURE

Если TransformerFactory.getFeature(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 — ссылка на файл не должна быть null.

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

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 — ссылка на файл не должна быть null.

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.