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 |
If |
Inherited constants | |
---|---|
Public constructors | |
---|---|
Zero-argument default constructor. |
|
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. |
|
StreamResult(f: File!) Construct a StreamResult from a File. |
Public methods | |
---|---|
open OutputStream! |
Get the byte stream that was set with setOutputStream. |
open String! |
Get the system identifier that was set with setSystemId. |
open Writer! |
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(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 |
setSystemId(f: File!) Set the system ID from a |
open Unit |
Set the writer that is to receive the result. |
Constants
FEATURE
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
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
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
StreamResult(systemId: String!)
Construct a StreamResult from a URL.
Parameters | |
---|---|
systemId |
String!: Must be a String that conforms to the URI syntax. |
StreamResult
StreamResult(f: File!)
Construct a StreamResult from a File.
Parameters | |
---|---|
f |
File!: Must a non-null File reference. |
Public methods
getOutputStream
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
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
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
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
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. |
setSystemId
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. |
setWriter
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. |