Module org.refcodes.io

Package org.refcodes.io

Class BoundedInputStream

java.lang.Object

java.io.InputStream

org.refcodes.io.BoundedInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BoundedInputStream
extends InputStream

A BoundedInputStream decorates an InputStream and restricts reading bytes from the InputStream decoratee up to a given total number of bytes (bounds). In case the total number of bytes readable has been exceeded then an according IOException is thrown.

Constructor Summary

Constructors

Constructor	Description
BoundedInputStream(InputStream aInputStream, int aTotalBytes)	Constructs a BoundedInputStream instances by decorating the given InputStream with the constraint of the given total number of bytes (bounds) which can be read.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
int	getBytesAvaialable()	Returns the total number of bytes to which this InputStream is bounded.
int	getBytesRead()	Returns the number of bytes already been read by this stream.
int	getTotalBytes()	The total number of bytes (bounds) which can be read from this InputStream.
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
byte[]	readAllBytes()
int	readNBytes(byte[] arg0, int arg1, int arg2)
void	reset()
long	skip(long n)
long	transferTo(OutputStream out)

Methods inherited from class java.io.InputStream

nullInputStream, readNBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundedInputStream

public BoundedInputStream(InputStream aInputStream,
                          int aTotalBytes)

Constructs a BoundedInputStream instances by decorating the given InputStream with the constraint of the given total number of bytes (bounds) which can be read.

Parameters:

aInputStream - The InputStream to be decorated.

aTotalBytes - The total number of bytes (bounds) available for reading.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException - if an I/O error occurs or the total number of bytes readable would be exceeded (has already been consumed).

getTotalBytes

public int getTotalBytes()

The total number of bytes (bounds) which can be read from this InputStream.

Returns:

The overall number of bytes which can be read.

getBytesRead

public int getBytesRead()

Returns the number of bytes already been read by this stream.

Returns:

The number of bytes already read.

getBytesAvaialable

public int getBytesAvaialable()

Returns the total number of bytes to which this InputStream is bounded.

Returns:

The total number of bytes (bounds).

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

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

read

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

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

readAllBytes

public byte[] readAllBytes()
                    throws IOException

Overrides:

readAllBytes in class InputStream

Throws:

IOException

readNBytes

public int readNBytes(byte[] arg0,
                      int arg1,
                      int arg2)
               throws IOException

Overrides:

readNBytes in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

transferTo

public long transferTo(OutputStream out)
                throws IOException

Overrides:

transferTo in class InputStream

Throws:

IOException