Module org.refcodes.io

Package org.refcodes.io

Class FilterInputStream

java.lang.Object

java.io.InputStream

org.refcodes.io.FilterInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class FilterInputStream
extends InputStream

The FilterInputStream wraps an InputStream adding filtering functionality of bytes to be skipped.

Constructor Summary

Constructors

Constructor	Description
FilterInputStream(InputStream aInputStream, byte... aFilterBytes)	Decorates the provided InputStream filtering functionality.
FilterInputStream(InputStream aInputStream, char... aFilterAsciiChars)	Decorates the provided InputStream filtering functionality.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
void	reset()

Methods inherited from class java.io.InputStream

nullInputStream, read, read, readAllBytes, readNBytes, readNBytes, skip, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterInputStream

public FilterInputStream(InputStream aInputStream,
                         byte... aFilterBytes)

Decorates the provided InputStream filtering functionality.

Parameters:

aInputStream - The InputStream to be decorated accordingly.

aFilterBytes - The bytes to be skipped (filtered out).

FilterInputStream

public FilterInputStream(InputStream aInputStream,
                         char... aFilterAsciiChars)
                  throws IllegalArgumentException

Decorates the provided InputStream filtering functionality.

Parameters:

aInputStream - The InputStream to be decorated accordingly.

aFilterAsciiChars - The ASCII characters to be skipped (filtered out).

Throws:

IllegalArgumentException - thrown in case a character is not an ASCII character.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

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

mark

public void mark(int readlimit)

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