to top
Android APIs
public class

StreamResult

extends Object
implements Result
java.lang.Object
   ↳ javax.xml.transform.stream.StreamResult

Class Overview

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.
[Expand]
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(File f)

Set the system ID from a File reference.

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 setWriter(Writer writer)
Set the writer that is to receive the result.
[Expand]
Inherited Methods
From class java.lang.Object
From interface javax.xml.transform.Result

Constants

public static final String FEATURE

Since: API Level 8

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

Since: API Level 8

Zero-argument default constructor.

public StreamResult (OutputStream outputStream)

Since: API Level 8

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)

Since: API Level 8

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)

Since: API Level 8

Construct a StreamResult from a URL.

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

public StreamResult (File f)

Since: API Level 8

Construct a StreamResult from a File.

Parameters
f Must a non-null File reference.

Public Methods

public OutputStream getOutputStream ()

Since: API Level 8

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

Since: API Level 8

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

Since: API Level 8

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)

Since: API Level 8

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 (File f)

Since: API Level 8

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

public void setSystemId (String systemId)

Since: API Level 8

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 setWriter (Writer writer)

Since: API Level 8

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.