intarsys runtime library

de.intarsys.tools.writer
Class EscapeWriter

java.lang.Object
  extended by java.io.Writer
      extended by de.intarsys.tools.writer.EscapeWriter
All Implemented Interfaces:
Closeable, Flushable, Appendable

public class EscapeWriter
extends Writer

A writer that escapes predefined character sequences.


Constructor Summary
EscapeWriter(Writer o)
          EscapeWriter constructor comment.
 
Method Summary
 void close()
          Close the stream, flushing it first.
 void flush()
          Flush the stream.
 String getDestinationChars()
           
 Writer getOut()
           
 String getSourceChars()
           
 void setDestinationChars(String newDestinationChars)
           
 void setSourceChars(String newSourceChars)
           
 void write(char[] cbuf, int off, int len)
           
 
Methods inherited from class java.io.Writer
append, append, append, write, write, write, write
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EscapeWriter

public EscapeWriter(Writer o)
EscapeWriter constructor comment.

Parameters:
o - java.io.Writer
Method Detail

close

public void close()
           throws 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 Closeable
Specified by:
close in class Writer
Throws:
IOException - If an I/O error occurs

flush

public void flush()
           throws 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 Flushable
Specified by:
flush in class Writer
Throws:
IOException - If an I/O error occurs

getDestinationChars

public String getDestinationChars()

getOut

public Writer getOut()

getSourceChars

public String getSourceChars()

setDestinationChars

public void setDestinationChars(String newDestinationChars)

setSourceChars

public void setSourceChars(String newSourceChars)

write

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

intarsys runtime library

Copyright © 2008 intarsys consulting GmbH. All Rights Reserved.