Added in API level 8

StreamResult

open class StreamResult : Result

kotlin.Any
↳	javax.xml.transform.stream.StreamResult

Acts as an holder for a transformation result, which may be XML, plain Text, HTML, or some other form of markup.

Summary

Constants
static String	`FEATURE` If `javax.xml.transform.TransformerFactory#getFeature` returns true when passed this value as an argument, the Transformer supports Result output of this type.

Inherited constants

From class Result

String

PI_DISABLE_OUTPUT_ESCAPING

The name of the processing instruction that is sent if the result tree disables output escaping.

Normally, result tree serialization escapes & and < (and possibly other characters) when outputting text nodes. This ensures that the output is well-formed XML. However, it is sometimes convenient to be able to produce output that is almost, but not quite well-formed XML; for example, the output may include ill-formed sections that will be transformed into well-formed XML by a subsequent non-XML aware process. If a processing instruction is sent with this name, serialization should be output without any escaping.

Result DOM trees may also have PI_DISABLE_OUTPUT_ESCAPING and PI_ENABLE_OUTPUT_ESCAPING inserted into the tree.

String

PI_ENABLE_OUTPUT_ESCAPING

The name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.

Public constructors
`StreamResult()` Zero-argument default constructor.
`StreamResult(f: File!)` Construct a StreamResult from a File.
`StreamResult(outputStream: OutputStream!)` Construct a StreamResult from a byte stream.
`StreamResult(writer: Writer!)` Construct a StreamResult from a character stream.
`StreamResult(systemId: String!)` Construct a StreamResult from a URL.

Public methods
open OutputStream!	`getOutputStream()` Get the byte stream that was set with setOutputStream.
open String!	`getSystemId()` Get the system identifier that was set with setSystemId.
open Writer!	`getWriter()` Get the character stream that was set with setWriter.
open Unit	`setOutputStream(outputStream: OutputStream!)` Set the ByteStream that is to be written to.
open Unit	`setSystemId(f: File!)` Set the system ID from a `File` reference.
open Unit	`setSystemId(systemId: String!)` Set the systemID that may be used in association with the byte or character stream, or, if neither is set, use this value as a writeable URI (probably a file name).
open Unit	`setWriter(writer: Writer!)` Set the writer that is to receive the result.

Constants

FEATURE

Added in API level 8

static val FEATURE: String

If javax.xml.transform.TransformerFactory#getFeature returns true when passed this value as an argument, the Transformer supports Result output of this type.

Value: "http://javax.xml.transform.stream.StreamResult/feature"

Public constructors

StreamResult

Added in API level 8

StreamResult()

Zero-argument default constructor.

StreamResult

Added in API level 8

StreamResult(f: File!)

Construct a StreamResult from a File.

Parameters
`f`	File!: Must a non-null File reference.

StreamResult

Added in API level 8

StreamResult(outputStream: OutputStream!)

Construct a StreamResult from a byte stream. Normally, a stream should be used rather than a reader, so that the transformer may use instructions contained in the transformation instructions to control the encoding.

Parameters
`outputStream`	OutputStream!: A valid OutputStream reference.

StreamResult

Added in API level 8

StreamResult(writer: Writer!)

Construct a StreamResult from a character stream. Normally, a stream should be used rather than a reader, so that the transformer may use instructions contained in the transformation instructions to control the encoding. However, there are times when it is useful to write to a character stream, such as when using a StringWriter.

Parameters
`writer`	Writer!: A valid Writer reference.

StreamResult

Added in API level 8

StreamResult(systemId: String!)

Construct a StreamResult from a URL.

Parameters
`systemId`	String!: Must be a String that conforms to the URI syntax.

Public methods

getOutputStream

Added in API level 8

open fun getOutputStream(): OutputStream!

Get the byte stream that was set with setOutputStream.

Return
`OutputStream!`	The byte stream that was set with setOutputStream, or null if setOutputStream or the ByteStream constructor was not called.

getSystemId

Added in API level 8

open fun getSystemId(): String!

Get the system identifier that was set with setSystemId.

Return
`String!`	The system identifier that was set with setSystemId, or null if setSystemId was not called.

getWriter

Added in API level 8

open fun getWriter(): Writer!

Get the character stream that was set with setWriter.

Return
`Writer!`	The character stream that was set with setWriter, or null if setWriter or the Writer constructor was not called.

setOutputStream

Added in API level 8

open fun setOutputStream(outputStream: OutputStream!): Unit

Set the ByteStream that is to be written to. Normally, a stream should be used rather than a reader, so that the transformer may use instructions contained in the transformation instructions to control the encoding.

Parameters
`outputStream`	OutputStream!: A valid OutputStream reference.

setSystemId

Added in API level 8

open fun setSystemId(f: File!): Unit

Set the system ID from a File reference.

Note the use of File.toURI() and File.toURL(). toURI() is preferred and used if possible. To allow JAXP 1.3 to run on J2SE 1.3, toURL() is used if a NoSuchMethodException is thrown by the attempt to use toURI().

Parameters
`f`	File!: Must a non-null File reference.

setSystemId

Added in API level 8

open fun setSystemId(systemId: String!): Unit

Set the systemID that may be used in association with the byte or character stream, or, if neither is set, use this value as a writeable URI (probably a file name).

Parameters
`systemId`	String!: The system identifier as a URI string.

setWriter

Added in API level 8

open fun setWriter(writer: Writer!): Unit

Set the writer that is to receive the result. Normally, a stream should be used rather than a writer, so that the transformer may use instructions contained in the transformation instructions to control the encoding. However, there are times when it is useful to write to a writer, such as when using a StringWriter.

Parameters
`writer`	Writer!: A valid Writer reference.