javax.xml.transform.stream: public class: StreamResult

javax.xml.transform.stream
public class: StreamResult [javadoc | source]

java.lang.Object
   javax.xml.transform.stream.StreamResult

All Implemented Interfaces:
Result

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

author: < - a href="Jeff.Suttor@Sun.com">Jeff Suttor

Field Summary
public static final String	FEATURE	If javax.xml.transform.TransformerFactory#getFeature returns true when passed this value as an argument, the Transformer supports Result output of this type.

Constructor:

Constructor:
public StreamResult() { } Zero-argument default constructor.
public StreamResult(OutputStream outputStream) { setOutputStream(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) { setWriter(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) { this.systemId = systemId; } Construct a StreamResult from a URL. Parameters: `systemId` - Must be a String that conforms to the URI syntax.
public StreamResult(File f) { //convert file to appropriate URI, f.toURI().toASCIIString() //converts the URI to string as per rule specified in //RFC 2396, setSystemId(f.toURI().toASCIIString()); } Construct a StreamResult from a File. Parameters: `f` - Must a non-null File reference.

 public StreamResult() {

}

Zero-argument default constructor.

 public StreamResult(OutputStream outputStream) {
        setOutputStream(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) {
        setWriter(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) {
        this.systemId = systemId;
}

Construct a StreamResult from a URL.

Parameters:

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

 public StreamResult(File f) {
        //convert file to appropriate URI, f.toURI().toASCIIString()
        //converts the URI to string as per rule specified in
        //RFC 2396,
        setSystemId(f.toURI().toASCIIString());
}

Construct a StreamResult from a File.

Parameters:

f - Must a non-null File reference.

Method from javax.xml.transform.stream.StreamResult Summary:
getOutputStream, getSystemId, getWriter, setOutputStream, setSystemId, setSystemId, setWriter

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.xml.transform.stream.StreamResult Detail:
public OutputStream getOutputStream() { return outputStream; } Get the byte stream that was set with setOutputStream.
public String getSystemId() { return systemId; } Get the system identifier that was set with setSystemId.
public Writer getWriter() { return writer; } Get the character stream that was set with setWriter.
public void setOutputStream(OutputStream outputStream) { this.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.
public void setSystemId(String systemId) { this.systemId = 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).
public void setSystemId(File f) { //convert file to appropriate URI, f.toURI().toASCIIString() //converts the URI to string as per rule specified in //RFC 2396, this.systemId = f.toURI().toASCIIString(); } Set the system ID from a `File` reference.
public void setWriter(Writer writer) { this.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.

Method from javax.xml.transform.stream.StreamResult Detail:

 public OutputStream getOutputStream() {
        return outputStream;
}

Get the byte stream that was set with setOutputStream.

 public String getSystemId() {
        return systemId;
}

Get the system identifier that was set with setSystemId.

 public Writer getWriter() {
        return writer;
}

Get the character stream that was set with setWriter.

 public  void setOutputStream(OutputStream outputStream) {
        this.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.

 public  void setSystemId(String systemId) {
        this.systemId = 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).

 public  void setSystemId(File f) {
        //convert file to appropriate URI, f.toURI().toASCIIString()
        //converts the URI to string as per rule specified in
        //RFC 2396,
        this.systemId = f.toURI().toASCIIString();
}

Set the system ID from a File reference.

 public  void setWriter(Writer writer) {
        this.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.