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 getFeature(String) returns true when passed this value as an argument, the Transformer supports Result output of this type.

Inherited Constant Summary

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

Constants

public static final 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

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