Module org.refcodes.io

Package org.refcodes.io

Class BlockingInputStream

java.lang.Object

java.io.InputStream

org.refcodes.io.BlockingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BlockingInputStream
extends InputStream

The BlockingInputStream wraps an InputStream adding blocking functionality, e.g. when trying to read the read operation is blocked till available() returns a value greater than 0. Use a TimeoutInputStream to combine the BlockingInputStream with a timeout.

Constructor Summary

Constructors

Constructor	Description
BlockingInputStream(InputStream aInputStream)	Decorates the provided InputStream blocking functionality

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] aB)
int	read(byte[] aB, int aOff, int aLen)
byte[]	readAllBytes()
int	readNBytes(byte[] aB, int aOff, int aLen)
void	reset()

Methods inherited from class java.io.InputStream

nullInputStream, readNBytes, skip, transferTo

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockingInputStream

public BlockingInputStream(InputStream aInputStream)

Decorates the provided InputStream blocking functionality

Parameters:

aInputStream - The InputStream to be decorated accordingly.

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] aB)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] aB,
                int aOff,
                int aLen)
         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[] aB,
                      int aOff,
                      int aLen)
               throws IOException

Overrides:

readNBytes 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