net.sf.kdgcommons.io

Class TeeInputStream

java.lang.Object

java.io.InputStream

net.sf.kdgcommons.io.TeeInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class TeeInputStream
extends InputStream

A decorator InputStream that writes all bytes read to a specified OutputStream.

Constructor Summary

Constructors

Constructor and Description
TeeInputStream(InputStream base, OutputStream tee)

Method Summary

Modifier and Type	Method and Description
int	available() Returns the number of bytes available from the base stream.
void	close() Closes the base stream, but not the tee.
void	mark(int readlimit) Sets a mark on the base stream.
boolean	markSupported() Returns whether the base stream supports mark(int).
int	read() Reads a single byte from the base, writing it to the tee.
int	read(byte[] b) Reads as many bytes as possible from the base, up to the size of the passed buffer, and writes them to the tee.
int	read(byte[] b, int off, int len) Reads multiple bytes from the base, into an arbitrary position in the specified buffer, and writes the same bytes to the tee.
void	reset() Resets the base stream to a preset mark.
long	skip(long n) Skips a specified number of bytes in the input stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

TeeInputStream

public TeeInputStream(InputStream base,
                      OutputStream tee)

Method Detail

available

public int available()
              throws IOException

Returns the number of bytes available from the base stream. Has no effect on the tee.

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Closes the base stream, but not the tee.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

read

public int read()
         throws IOException

Reads a single byte from the base, writing it to the tee. If at end-of-file on the base, has no effect on the tee.

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Reads multiple bytes from the base, into an arbitrary position in the specified buffer, and writes the same bytes to the tee. If no bytes read, has no effect on the tee.

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Reads as many bytes as possible from the base, up to the size of the passed buffer, and writes them to the tee. If no bytes read, has no effect on the tee.

Overrides:

read in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Returns whether the base stream supports mark(int). Has no effect on the tee.

Overrides:

markSupported in class InputStream

mark

public void mark(int readlimit)

Sets a mark on the base stream. Has no effect on the tee.

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Resets the base stream to a preset mark. Has no effect on the tee.

Overrides:

reset in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Skips a specified number of bytes in the input stream. Has no effect on the tee.

Overrides:

skip in class InputStream

Throws:

IOException