org.yajul.io
Class TeeOutputStream

java.lang.Object
  java.io.OutputStream
      java.io.FilterOutputStream
          org.yajul.io.TeeOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable

public class TeeOutputStream
extends java.io.FilterOutputStream

An output stream filter that writes to multiple underlying output streams.

Author:

josh

Field Summary

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

TeeOutputStream(java.io.OutputStream[] streams)
Creates a new output stream that writes output to all of the streams in the array.

TeeOutputStream(java.io.OutputStream out, java.io.OutputStream out2)
Creates a new output stream that echoes output to both of the specified streams.

Method Summary

void	close() Closes this output stream and releases any system resources associated with the stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out to the stream.
void	write(byte[] b) Writes b.length bytes to this output stream.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to this output stream.
void	write(int b) Writes the specified byte to this output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

TeeOutputStream

public TeeOutputStream(java.io.OutputStream out,
                       java.io.OutputStream out2)

Creates a new output stream that echoes output to both of the specified streams.

Parameters:

out - The main underlying output stream.

out2 - The 'tee' output stream.

TeeOutputStream

public TeeOutputStream(java.io.OutputStream[] streams)

Creates a new output stream that writes output to all of the streams in the array.

Parameters:

streams - An array of streams to write to.

Method Detail

close

public void close()
           throws java.io.IOException

Closes this output stream and releases any system resources associated with the stream.

The close method of FilterOutputStream calls its flush method, and then calls the close method of its underlying output stream.

NOTE: This implementation also closes the 'tee' streams as well.

Specified by:

close in interface java.io.Closeable

Overrides:

close in class java.io.FilterOutputStream

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

FilterOutputStream.flush(), FilterOutputStream.out

flush

public void flush()
           throws java.io.IOException

Flushes this output stream and forces any buffered output bytes to be written out to the stream.

The flush method of FilterOutputStream calls the flush method of its underlying output stream.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.FilterOutputStream

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

FilterOutputStream.out

write

public void write(byte[] b)
           throws java.io.IOException

Writes b.length bytes to this output stream.

The write method of FilterOutputStream calls its write method of three arguments with the arguments b, 0, and b.length.

Note that this method does not call the one-argument write method of its underlying stream with the single argument b.

NOTE: This implementation also writes to the 'tee' streams as well.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - the data to be written.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

FilterOutputStream.write(byte[],int,int)

write

public void write(byte[] b,
                  int off,
                  int len)
           throws java.io.IOException

Writes len bytes from the specified byte array starting at offset off to this output stream.

The write method of FilterOutputStream calls the write method of one argument on each byte to output.

Note that this method does not call the write method of its underlying input stream with the same arguments. Subclasses of FilterOutputStream should provide a more efficient implementation of this method.

NOTE: This implementation also writes to the 'tee' streams as well.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

FilterOutputStream.write(int)

write

public void write(int b)
           throws java.io.IOException

Writes the specified byte to this output stream.

The write method of FilterOutputStream calls the write method of its underlying output stream, that is, it performs out.write(b).

Implements the abstract write method of OutputStream.

NOTE: This implementation also writes to the 'tee' streams as well.

Overrides:

write in class java.io.FilterOutputStream

Parameters:

b - the byte.

Throws:

java.io.IOException - if an I/O error occurs.