StreamResult (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • javax.xml.transform.stream.StreamResult

• All Implemented Interfaces:
  Result

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.

• • Field Summary

  Fields

  Modifier and Type	Field	Description
  static String	FEATURE	If TransformerFactory.getFeature(java.lang.String) returns true when passed this value as an argument, the Transformer supports Result output of this type.

     * ### Fields inherited from interface javax.xml.transform.[Result](../../../../javax/xml/transform/Result.html "interface in javax.xml.transform")  
     `[PI_DISABLE_OUTPUT_ESCAPING](../../../../javax/xml/transform/Result.html#PI%5FDISABLE%5FOUTPUT%5FESCAPING), [PI_ENABLE_OUTPUT_ESCAPING](../../../../javax/xml/transform/Result.html#PI%5FENABLE%5FOUTPUT%5FESCAPING)`  

  • Constructor Summary

  Constructors

  Constructor	Description
  StreamResult()	Zero-argument default constructor.
  StreamResult(File f)	Construct a StreamResult from a File.
  StreamResult(OutputStream outputStream)	Construct a StreamResult from a byte stream.
  StreamResult(String systemId)	Construct a StreamResult from a URL.
  StreamResult(Writer writer)	Construct a StreamResult from a character stream.

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  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.

     * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../../java/lang/Object.html#clone--), [equals](../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../java/lang/Object.html#finalize--), [getClass](../../../../java/lang/Object.html#getClass--), [hashCode](../../../../java/lang/Object.html#hashCode--), [notify](../../../../java/lang/Object.html#notify--), [notifyAll](../../../../java/lang/Object.html#notifyAll--), [toString](../../../../java/lang/Object.html#toString--), [wait](../../../../java/lang/Object.html#wait--), [wait](../../../../java/lang/Object.html#wait-long-), [wait](../../../../java/lang/Object.html#wait-long-int-)`

• • Field Detail

     * #### FEATURE  
     public static final [String](../../../../java/lang/String.html "class in java.lang") FEATURE  
     See Also:  
     [Constant Field Values](../../../../constant-values.html#javax.xml.transform.stream.StreamResult.FEATURE)  

  • Constructor Detail

    * #### StreamResult  
    public StreamResult()  
    Zero-argument default constructor.  
    * #### StreamResult  
    public StreamResult([OutputStream](../../../../java/io/OutputStream.html "class in java.io") 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.  
    * #### StreamResult  
    public StreamResult([Writer](../../../../java/io/Writer.html "class in java.io") 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.  
    * #### StreamResult  
    public StreamResult([String](../../../../java/lang/String.html "class in java.lang") systemId)  
    Construct a StreamResult from a URL.  
    Parameters:  
    `systemId` \- Must be a String that conforms to the URI syntax.  
    * #### StreamResult  
    public StreamResult([File](../../../../java/io/File.html "class in java.io") f)  
    Construct a StreamResult from a File.  
    Parameters:  
    `f` \- Must a non-null File reference.  

  • Method Detail

    * #### setOutputStream  
    public void setOutputStream([OutputStream](../../../../java/io/OutputStream.html "class in java.io") 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.  
    * #### getOutputStream  
    public [OutputStream](../../../../java/io/OutputStream.html "class in java.io") 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.  
    * #### setWriter  
    public void setWriter([Writer](../../../../java/io/Writer.html "class in java.io") 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.  
    * #### getWriter  
    public [Writer](../../../../java/io/Writer.html "class in java.io") 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.  
    * #### setSystemId  
    public void setSystemId([String](../../../../java/lang/String.html "class in java.lang") 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).  
    Specified by:  
    `[setSystemId](../../../../javax/xml/transform/Result.html#setSystemId-java.lang.String-)` in interface `[Result](../../../../javax/xml/transform/Result.html "interface in javax.xml.transform")`  
    Parameters:  
    `systemId` \- The system identifier as a URI string.  
    * #### setSystemId  
    public void setSystemId([File](../../../../java/io/File.html "class in java.io") f)  
    Set the system ID from a `File` reference.  
    Parameters:  
    `f` \- Must a non-null File reference.  
    * #### getSystemId  
    public [String](../../../../java/lang/String.html "class in java.lang") getSystemId()  
    Get the system identifier that was set with setSystemId.  
    Specified by:  
    `[getSystemId](../../../../javax/xml/transform/Result.html#getSystemId--)` in interface `[Result](../../../../javax/xml/transform/Result.html "interface in javax.xml.transform")`  
    Returns:  
    The system identifier that was set with setSystemId, or null if setSystemId was not called.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.