Класс StreamResult

java.lang.Object

javax.xml.transform.stream.StreamResult

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

public class StreamResult extends Object implements Result

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

С тех пор:: 1.4

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

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

Поля, объявленные в интерфейсе javax.xml.transform.Result

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

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

Конструктор	Описание
`StreamResult()`	Конструктор по умолчанию без аргументов.
`StreamResult(File f)`	Создаёт StreamResult из файла.
`StreamResult(OutputStream outputStream)`	Создаёт StreamResult из потока байтов.
`StreamResult(Writer writer)`	Создаёт StreamResult из потока символов.
`StreamResult(String systemId)`	Создаёт StreamResult из URL.

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

Модификатор и тип	Метод	Описание
`OutputStream`	`getOutputStream()`	Получить поток байтов, установленный с помощью setOutputStream.
`String`	`getSystemId()`	Получить идентификатор системы, установленный с помощью setSystemId.
`Writer`	`getWriter()`	Получить поток символов, установленный с помощью setWriter.
`void`	`setOutputStream(OutputStream outputStream)`	Установить поток байтов, в который нужно записать результат.
`void`	`setSystemId(File f)`	Установить идентификатор системы по ссылке `File`.
`void`	`setSystemId(String systemId)`	Установить идентификатор системы, который может быть использован в связи с потоком байтов или символов. Если ни один из них не установлен, используйте это значение в качестве записываемого URI (вероятно, имя файла).
`void`	`setWriter(Writer writer)`	Установить поток символов для получения результата.

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

См. также:

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

StreamResult

public StreamResult()

Конструктор по умолчанию без аргументов.

StreamResult

public StreamResult(OutputStream outputStream)

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

Параметры:: outputStream - Действительная ссылка на OutputStream.

StreamResult

public StreamResult(Writer writer)

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

Параметры:: writer - Действительная ссылка на Writer.

StreamResult

public StreamResult(String systemId)

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

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

StreamResult

public StreamResult(File f)

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

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

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

setOutputStream

public void setOutputStream(OutputStream outputStream)

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

Параметры:: outputStream - Действительная ссылка на OutputStream.

getOutputStream

public OutputStream getOutputStream()

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

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

setWriter

public void setWriter(Writer writer)

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

Параметры:: writer - Действительная ссылка на Writer.

getWriter

public Writer getWriter()

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

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

setSystemId

public void setSystemId(String systemId)

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

Задано в:: setSystemId в интерфейсе Result
Параметры:: systemId - Идентификатор системы в виде строки URI.

setSystemId

public void setSystemId(File f)

Установить идентификатор системы по ссылке File.

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

getSystemId

public String getSystemId()

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

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

© 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/StreamResult.html