Class ExpandedStreamResult

java.lang.Object
net.sf.saxon.serialize.ExpandedStreamResult

public class ExpandedStreamResult extends Object
An ExpandedStreamResult is similar to a StreamResult, and is created from a StreamResult. It contains methods to construct a Writer from an OutputStream, and an OutputStream from a File or URI, and (unlike StreamResult) its getWriter() and getOutputStream() methods can therefore be used whether or not the writer and outputstream were explicitly set.
  • Constructor Details

  • Method Details

    • obtainUnicodeWriter

      public UnicodeWriter obtainUnicodeWriter() throws XPathException
      Make a UnicodeWriter for an Emitter to use.
      Returns:
      the new UnicodeWriter
      Throws:
      XPathException - if an error occurs
    • obtainOutputStream

      protected OutputStream obtainOutputStream() throws XPathException
      Throws:
      XPathException
    • isMustCloseAfterUse

      public boolean isMustCloseAfterUse()
      Ask whether the unicode writer myst be closed after use. This will typically be true if the writer was created by Saxon, rather than being supplied by the user.
      Returns:
      tru if the unicode writer myst be closed after use
    • makeWritableOutputFile

      public static File makeWritableOutputFile(String uriString) throws URISyntaxException, XPathException
      Throws:
      URISyntaxException
      XPathException
    • usesWriter

      public boolean usesWriter()
      Determine whether the Emitter wants a Writer for character output or an OutputStream for binary output. The standard Emitters all use a Writer, so this returns true; but a subclass can override this if it wants to use an OutputStream
      Returns:
      true if a Writer is needed, as distinct from an OutputStream
    • setWriter

      public void setWriter(Writer writer) throws XPathException
      Set the output destination as a character stream
      Parameters:
      writer - the Writer to use as an output destination
      Throws:
      XPathException - if an error occurs
    • getWriter

      public Writer getWriter()
      Get the output writer
      Returns:
      the Writer being used as an output destination, if any
    • getOutputStream

      public OutputStream getOutputStream()
      Get the output stream
      Returns:
      the OutputStream being used as an output destination, if any
    • getCharacterSet

      public CharacterSet getCharacterSet()
      Get the character set
      Returns:
      the CharacterSet