Класс 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 | Модификатор и тип | Поле | Описание |
|---|---|---|
static final String |
PI_DISABLE_OUTPUT_ESCAPING |
Имя инструкции обработки, которая отправляется, если в дереве результатов отключено экранирование вывода. |
static final String |
PI_ENABLE_OUTPUT_ESCAPING |
Имя инструкции обработки, которая отправляется, если в дереве результатов в какой-либо момент включается экранирование вывода после получения инструкции обработки PI_DISABLE_OUTPUT_ESCAPING. |
Краткое описание конструкторов
| Конструктор | Описание |
|---|---|
StreamResult() |
Конструктор по умолчанию без аргументов. |
StreamResult |
Создает StreamResult из объекта File. |
StreamResult |
Создает StreamResult из потока байтов. |
StreamResult |
Создает StreamResult из символьного потока. |
StreamResult |
Создает StreamResult из URL. |
Краткое описание методов
| Модификатор и тип | Метод | Описание |
|---|---|---|
OutputStream |
getOutputStream() |
Возвращает поток байтов, заданный с помощью setOutputStream. |
String |
getSystemId() |
Возвращает системный идентификатор, заданный с помощью setSystemId. |
Writer |
getWriter() |
Возвращает символьный поток, заданный с помощью setWriter. |
void |
setOutputStream |
Задает поток байтов, в который будет производиться запись. |
void |
setSystemId |
Задает системный идентификатор из ссылки File. |
void |
setSystemId |
Задает systemID, который может использоваться вместе с потоком байтов или символов либо, если ни один из них не задан, используется как URI для записи (вероятно, имя файла). |
void |
setWriter |
Задает объект записи, который будет получать результат. |
Методы, объявленные в классе Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | Модификатор и тип | Метод | Описание |
|---|---|---|
protected Object |
clone() |
Создает и возвращает копию этого объекта. |
boolean |
equals |
Указывает, равен ли этот объект какому-либо другому объекту. |
protected void |
finalize() |
Устарело, будет удалено: этот элемент API подлежит удалению в будущей версии. Финализация устарела и подлежит удалению в одном из будущих выпусков. |
final Class |
getClass() |
Возвращает класс времени выполнения этого Object. |
int |
hashCode() |
Возвращает значение хеш-кода для этого объекта. |
final void |
notify() |
Пробуждает один поток, ожидающий на мониторе этого объекта. |
final void |
notifyAll() |
Пробуждает все потоки, ожидающие на мониторе этого объекта. |
String |
toString() |
Возвращает строковое представление объекта. |
final void |
wait() |
Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt. |
final void |
wait |
Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени. |
final void |
wait |
Заставляет текущий поток ожидать пробуждения, обычно в результате вызова notify или interrupt, либо до истечения заданного промежутка реального времени. |
Подробное описание полей
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 из объекта File.
- Параметры:
-
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)
Задает 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, 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.