Skip to content

Most visited

Recently visited

navigation
Added in API level 8

StreamResult

public class StreamResult
extends Object implements Result

java.lang.Object
   ↳ 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

String FEATURE

If getFeature(String) returns true when passed this value as an argument, the Transformer supports Result output of this type.

Inherited constants

From interface javax.xml.transform.Result

Public constructors

StreamResult()

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(String systemId)

Construct a StreamResult from a URL.

StreamResult(File f)

Construct a StreamResult from a File.

Public methods

OutputStream getOutputStream()

Get the byte stream that was set with setOutputStream.

String getSystemId()

Get the system identifier that was set with setSystemId.

Writer getWriter()

Get the character stream that was set with setWriter.

void setOutputStream(OutputStream outputStream)

Set the ByteStream that is to be written to.

void setSystemId(String systemId)

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).

void setSystemId(File f)

Set the system ID from a File reference.

void setWriter(Writer writer)

Set the writer that is to receive the result.

Inherited methods

From class java.lang.Object
From interface javax.xml.transform.Result

Constants

FEATURE

Added in API level 8
String FEATURE

If getFeature(String) returns true when passed this value as an argument, the Transformer supports Result output of this type.

Constant 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 (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 (String systemId)

Construct a StreamResult from a URL.

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

StreamResult

Added in API level 8
StreamResult (File f)

Construct a StreamResult from a File.

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

Public methods

getOutputStream

Added in API level 8
OutputStream getOutputStream ()

Get the byte stream that was set with setOutputStream.

Returns
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
String getSystemId ()

Get the system identifier that was set with setSystemId.

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

getWriter

Added in API level 8
Writer getWriter ()

Get the character stream that was set with setWriter.

Returns
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
void setOutputStream (OutputStream outputStream)

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
void setSystemId (String systemId)

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

Added in API level 8
void setSystemId (File f)

Set the system ID from a File reference.

Note the use of toURI() and 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

Added in API level 8
void setWriter (Writer writer)

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.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.