StreamResult

public class StreamResult extends Object
implements Result

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

Constant Summary

String

FEATURE

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

Inherited Constant Summary

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 Constructor Summary

	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 Method Summary

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 Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

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

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

public StreamResult ()

Zero-argument default constructor.

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	A valid OutputStream reference.

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	A valid Writer reference.

public StreamResult (String systemId)

Construct a StreamResult from a URL.

Parameters

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

public StreamResult (File f)

Construct a StreamResult from a File.

Parameters

f	Must a non-null File reference.

Public Methods

public OutputStream getOutputStream ()

Get the byte stream that was set with setOutputStream.

Returns

• The byte stream that was set with setOutputStream, or null if setOutputStream or the ByteStream constructor was not called.

public String getSystemId ()

Get the system identifier that was set with setSystemId.

Returns

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

public Writer getWriter ()

Get the character stream that was set with setWriter.

Returns

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

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	A valid OutputStream reference.

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	The system identifier as a URI string.

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	Must a non-null File reference.

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	A valid Writer reference.