Home » xml-commons-external-1.4.01-src » javax » xml » transform » stream » [javadoc | source]
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.

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:
 public StreamResult() 
 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.
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() 
    Get the byte stream that was set with setOutputStream.
 public String getSystemId() 
    Get the system identifier that was set with setSystemId.
 public Writer getWriter() 
    Get the character stream that was set with setWriter.
 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.
 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).
 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().

 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.