Added in API level 8

Summary: Constants | Inherited Constants | Ctors | Methods | Inherited Methods

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 TransformerFactory.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 String PI_DISABLE_OUTPUT_ESCAPING The name of the processing instruction that is sent if the result tree disables output escaping. 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(File f) 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(String systemId) Construct a StreamResult from a URL.

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 Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface javax.xml.transform.Result abstract String getSystemId() Get the system identifier that was set with setSystemId. abstract void setSystemId(String systemId) Set the system identifier for this Result.

Constants

FEATURE

Added in API level 8

public static final String FEATURE

If TransformerFactory.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

public StreamResult ()

Zero-argument default constructor.

StreamResult

Added in API level 8

public StreamResult (File f)

Construct a StreamResult from a File.

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

StreamResult

Added in API level 8

public 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

public 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

public StreamResult (String systemId)

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

public 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

public 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

public 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

public 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

public 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

public void setSystemId (File f)

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

Added in API level 8

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