Package de.intarsys.tools.writer

Class EscapeWriter

  • All Implemented Interfaces:
    java.io.Closeable, java.io.Flushable, java.lang.Appendable, java.lang.AutoCloseable
    public class EscapeWriter
extends java.io.Writer
    A writer that escapes predefined character sequences.

    • Field Summary

      • Fields inherited from class java.io.Writer

        lock

    • Constructor Summary

      Constructors 
      Constructor Description
      EscapeWriter​(java.io.Writer o)
      EscapeWriter constructor comment.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void close()
      Close the stream, flushing it first.
      void flush()
      Flush the stream.
      java.lang.String getDestinationChars()  
      java.io.Writer getOut()  
      java.lang.String getSourceChars()  
      void setDestinationChars​(java.lang.String newDestinationChars)  
      void setSourceChars​(java.lang.String newSourceChars)  
      void write​(char[] cbuf, int off, int len)  

      • Methods inherited from class java.io.Writer

        append, append, append, nullWriter, write, write, write, write

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • EscapeWriter

        public EscapeWriter​(java.io.Writer o)
        EscapeWriter constructor comment.
        Parameters:
        o - java.io.Writer

    • Method Detail

      • close

        public void close()
           throws java.io.IOException
        Close the stream, flushing it first. Once a stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously-closed stream, however, has no effect.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in class java.io.Writer
        Throws:
        java.io.IOException - If an I/O error occurs

      • flush

        public void flush()
           throws java.io.IOException
        Flush the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.
        Specified by:
        flush in interface java.io.Flushable
        Specified by:
        flush in class java.io.Writer
        Throws:
        java.io.IOException - If an I/O error occurs

      • getDestinationChars

        public java.lang.String getDestinationChars()

      • getOut

        public java.io.Writer getOut()

      • getSourceChars

        public java.lang.String getSourceChars()

      • setDestinationChars

        public void setDestinationChars​(java.lang.String newDestinationChars)

      • setSourceChars

        public void setSourceChars​(java.lang.String newSourceChars)

      • write

        public void write​(char[] cbuf,
                  int off,
                  int len)
           throws java.io.IOException
        Specified by:
        write in class java.io.Writer
        Throws:
        java.io.IOException