Spec-Zone.ru › OpenJDK 17

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

Поля, объявленные в интерфейсе 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)
Установка объекта 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 при передаче этого значения в качестве аргумента, Transformer поддерживает вывод результата этого типа.
См. также:
  • Значения константных полей

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

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)
Установка объекта Writer для получения результата. Обычно поток должен использоваться вместо объекта 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, 2021, 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/17/docs/api/java.xml/javax/xml/transform/stream/StreamResult.html

Spec-Zone.ru

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