Module org.refcodes.io

Package org.refcodes.io

Class InverseInputStream

java.lang.Object

java.io.InputStream

org.refcodes.io.InverseInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class InverseInputStream
extends InputStream

A InverseInputStream wraps an InputStream and consumes input bytes by applying a InverseFunction on each byte read from the provided InputStream before passing back the processed byte to the caller. The input of the InverseInputStream can be converted back by the according BijectiveOutputStream.

Constructor Summary

Constructors

Constructor	Description
InverseInputStream(InputStream aInputStream, org.refcodes.numerical.InverseFunction<Byte,Byte> aInverseFunction)	Constructs the InverseInputStream by wrapping the given InputStream for the provided InverseFunction to be applied on the bytes to be read.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
boolean	equals(Object aObj)
int	hashCode()
void	mark(int aReadlimit)
boolean	markSupported()
int	read()
void	reset()
long	skip(long aArg0)
String	toString()

Methods inherited from class java.io.InputStream

nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

InverseInputStream

public InverseInputStream(InputStream aInputStream,
 org.refcodes.numerical.InverseFunction<Byte,Byte> aInverseFunction)

Constructs the InverseInputStream by wrapping the given InputStream for the provided InverseFunction to be applied on the bytes to be read.

Parameters:

aInputStream - The InputStream to be wrapped.

aInverseFunction - The InverseFunction to be applied to the bytes to be read.

Method Details

available

public int available()
              throws IOException

Overrides:

available in class InputStream

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

equals

public boolean equals(Object aObj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

mark

public void mark(int aReadlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

skip

public long skip(long aArg0)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object