Module org.refcodes.io

Package org.refcodes.io

Class InputStreamTap

java.lang.Object

java.io.InputStream

org.refcodes.io.InputStreamTap

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class InputStreamTap
extends InputStream
implements Flushable

The InputStreamTap decorates an InputStreamTap by tapping (sniffing data from) an InputStream and besides returning the read data writes it to the provided OutputStream. In conjunction with the HexOutputStream the data read from the provided InputStream via the InputStreamTap may be printed out as Hex codes for debugging purposes.

Constructor Summary

Constructors

Constructor	Description
InputStreamTap(InputStream aInputStream, OutputStream aOutbutStream)	Constructs an InputStreamTap decorating the provided InputStream with tap functionality delegating data to the provided OutputStream.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	flush()
void	mark(int aReadlimit)
boolean	markSupported()
int	read()
int	read(byte[] bytes)
int	read(byte[] bytes, int offset, int length)
byte[]	readAllBytes()
int	readNBytes(byte[] bytes, int offset, int length)
byte[]	readNBytes(int length)
void	reset()
long	skip(long aN)
void	skipNBytes(long aN)
String	toString()
long	transferTo(OutputStream aOut)

Methods inherited from class java.io.InputStream

nullInputStream

Methods inherited from class java.lang.Object

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

Constructor Details

InputStreamTap

public InputStreamTap(InputStream aInputStream,
 OutputStream aOutbutStream)

Constructs an InputStreamTap decorating the provided InputStream with tap functionality delegating data to the provided OutputStream.

Parameters:

aInputStream - The InputStream to be decorated.

aOutbutStream - The OutputStream where to also write the read data (from the InputStream) to.

Method Details

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] bytes)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] bytes,
 int offset,
 int length)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

readAllBytes

public byte[] readAllBytes()
                    throws IOException

Overrides:

readAllBytes in class InputStream

Throws:

IOException

readNBytes

public byte[] readNBytes(int length)
                  throws IOException

Overrides:

readNBytes in class InputStream

Throws:

IOException

readNBytes

public int readNBytes(byte[] bytes,
 int offset,
 int length)
               throws IOException

Overrides:

readNBytes in class InputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object

skip

public long skip(long aN)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

skipNBytes

public void skipNBytes(long aN)
                throws IOException

Overrides:

skipNBytes in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

mark

public void mark(int aReadlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

transferTo

public long transferTo(OutputStream aOut)
                throws IOException

Overrides:

transferTo in class InputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

Throws:

IOException