Class BinaryStreamWriter

    • Constructor Summary

      Constructors 
      Constructor Description
      BinaryStreamWriter​(java.io.OutputStream outputStream)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAttribute​(java.lang.String name, java.lang.String value)  
      void close()
      Close the writer, if necessary.
      void endNode()  
      void flush()
      Flush the writer, if necessary.
      void setValue​(java.lang.String text)
      Write the value (text content) of the current node.
      void startNode​(java.lang.String name)  
      void startNode​(java.lang.String name, java.lang.Class clazz)  
      HierarchicalStreamWriter underlyingWriter()
      Return the underlying HierarchicalStreamWriter implementation.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • BinaryStreamWriter

        public BinaryStreamWriter​(java.io.OutputStream outputStream)
    • Method Detail

      • underlyingWriter

        public HierarchicalStreamWriter underlyingWriter()
        Description copied from interface: HierarchicalStreamWriter
        Return the underlying HierarchicalStreamWriter implementation.

        If a Converter needs to access methods of a specific HierarchicalStreamWriter implementation that are not defined in the HierarchicalStreamWriter interface, it should call this method before casting. This is because the writer passed to the Converter is often wrapped/decorated by another implementation to provide additional functionality (such as XPath tracking).

        For example:

        MySpecificWriter mySpecificWriter = (MySpecificWriter)writer; // INCORRECT!
         mySpecificWriter.doSomethingSpecific();
        MySpecificWriter mySpecificWriter = (MySpecificWriter)writer.underlyingWriter();  // CORRECT!
         mySpecificWriter.doSomethingSpecific();

        Implementations of HierarchicalStreamWriter should return 'this', unless they are a decorator, in which case they should delegate to whatever they are wrapping.

        Specified by:
        underlyingWriter in interface HierarchicalStreamWriter