Spec-Zone.ru › OpenJDK 25

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

Поля, объявленные в интерфейсе 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)
Задает ByteStream, в который будут записываться данные.
void setSystemId(File f)
Задает системный идентификатор из ссылки на File.
void setSystemId(String systemId)
Задает systemID, который может использоваться вместе с байтовым или символьным потоком; если ни один из них не задан, это значение используется как URI для записи (вероятно, имя файла).
void setWriter(Writer writer)
Задает средство записи, которое будет получать результат.

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

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

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

FEATURE

public static final String FEATURE
Если TransformerFactory.getFeature(String) возвращает true при передаче этого значения в качестве аргумента, Transformer поддерживает вывод Result этого типа.
См. также:
  • Значения констант

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

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)
Задает ByteStream, в который будут записываться данные. Обычно следует использовать поток, а не средство чтения, чтобы преобразователь мог использовать инструкции, содержащиеся в инструкциях преобразования, для управления кодировкой.
Параметры:
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)
Задает 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 не вызывался.

Сообщить об ошибке или предложить улучшение
Дополнительные справочные материалы по API и документацию для разработчиков см. в документации Java SE, содержащей более подробные описания для разработчиков, концептуальные обзоры, определения терминов, обходные решения и примеры работающего кода. Другие версии.
Java является товарным знаком или зарегистрированным товарным знаком Oracle и/или ее аффилированных лиц в США и других странах.
Авторское право © 1993, 2025, Oracle и/или ее аффилированные лица, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
Все права защищены. Использование регулируется условиями лицензии и политикой распространения документации.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API