Класс StreamResult

Все реализуемые интерфейсы:
Result
public class StreamResult
extends Object
implements Result

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

С:
1.4

Поля

Модификатор и тип Поле Описание
static 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)

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

void setWriter​(Writer 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 - Должна быть ссылка на непустой файл.

Методы

setOutputStream

public void setOutputStream(OutputStream outputStream)

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

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

getOutputStream

public OutputStream getOutputStream()

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

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

setWriter

public void setWriter(Writer writer)

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

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

getWriter

public Writer getWriter()

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

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

setSystemId

public void setSystemId(String systemId)

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

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

setSystemId

public void setSystemId(File f)

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

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

getSystemId

public String getSystemId()

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

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

© 1993, 2020, 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/11/docs/api/java.xml/javax/xml/transform/stream/StreamResult.html

Spec-Zone .ru
спецификации, руководства, описания, API