org.geotools.io
Class EchoWriter

java.lang.Object
  extended by java.io.Writer
      extended by java.io.FilterWriter
          extended by org.geotools.io.EchoWriter
All Implemented Interfaces:
java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class EchoWriter
extends java.io.FilterWriter

A writer that copy all output to an other stream. This writer can be used for perfoming an exact copy of what is sent to an other writer. For example, it may be used for echoing to the standard output the content sent to a file. This writer is usefull for debugging purpose.

Since:
2.1
Version:
$Id: EchoWriter.java 31015 2008-07-15 11:29:32Z desruisseaux $
Author:
Martin Desruisseaux (IRD)

Field Summary
 
Fields inherited from class java.io.FilterWriter
out
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
EchoWriter(java.io.Writer main)
          Creates a writer that will echo to the standard output.
EchoWriter(java.io.Writer main, java.io.Writer echo)
          Creates a copy writter for the specified stream.
 
Method Summary
 void close()
          Closes the main stream and the echo stream.
 void flush()
          Flushs both streams.
 void write(char[] cbuf)
          Writes an array of characters.
 void write(char[] cbuf, int offset, int length)
          Writes a portion of an array of characters.
 void write(int c)
          Writes a single character.
 void write(java.lang.String string)
          Writes a string.
 void write(java.lang.String string, int offset, int length)
          Writes a portion of a string.
 
Methods inherited from class java.io.Writer
append, append, append
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EchoWriter

public EchoWriter(java.io.Writer main)
Creates a writer that will echo to the standard output. Each line to that standard output will be numbered.

Parameters:
main - The main stream.

EchoWriter

public EchoWriter(java.io.Writer main,
                  java.io.Writer echo)
Creates a copy writter for the specified stream.

Parameters:
main - The main stream.
echo - The echo stream.
Method Detail

write

public void write(int c)
           throws java.io.IOException
Writes a single character.

Overrides:
write in class java.io.FilterWriter
Parameters:
c - The character to write.
Throws:
java.io.IOException - If an I/O error occurs.

write

public void write(char[] cbuf)
           throws java.io.IOException
Writes an array of characters.

Overrides:
write in class java.io.Writer
Parameters:
cbuf - Buffer of characters to be written.
Throws:
java.io.IOException - If an I/O error occurs.

write

public void write(char[] cbuf,
                  int offset,
                  int length)
           throws java.io.IOException
Writes a portion of an array of characters.

Overrides:
write in class java.io.FilterWriter
Parameters:
cbuf - Buffer of characters to be written.
offset - Offset from which to start reading characters.
length - Number of characters to be written.
Throws:
java.io.IOException - If an I/O error occurs.

write

public void write(java.lang.String string)
           throws java.io.IOException
Writes a string.

Overrides:
write in class java.io.Writer
Parameters:
string - String to be written.
Throws:
java.io.IOException - If an I/O error occurs.

write

public void write(java.lang.String string,
                  int offset,
                  int length)
           throws java.io.IOException
Writes a portion of a string.

Overrides:
write in class java.io.FilterWriter
Parameters:
string - String to be written.
offset - Offset from which to start writing characters.
length - Number of characters to write.
Throws:
java.io.IOException - If an I/O error occurs.

flush

public void flush()
           throws java.io.IOException
Flushs both streams.

Specified by:
flush in interface java.io.Flushable
Overrides:
flush in class java.io.FilterWriter
Throws:
java.io.IOException - If an I/O error occurs.

close

public void close()
           throws java.io.IOException
Closes the main stream and the echo stream. In the particular case of writers created with the one argument constructor, the echo stream will not be closed since it maps to the standard output.

Specified by:
close in interface java.io.Closeable
Overrides:
close in class java.io.FilterWriter
Throws:
java.io.IOException - If an I/O error occurs.


Copyright © 1996-2010 Geotools. All Rights Reserved.