Class BaseEncoderInputStream

java.lang.Object

java.io.InputStream

org.refcodes.codec.BaseEncoderInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BaseEncoderInputStream
extends InputStream

The BaseEncoderInputStream encodes data read from an underlying InputStream using the configured BaseMetrics.

Decoded bytes are read lazily from the wrapped input stream and passed to a BaseEncoder. The bytes emitted by the encoder are buffered internally and returned through the regular InputStream interface.

The stream must be closed after use so that the wrapped input stream and the encoder resources are released. When the end of the wrapped input stream is reached, the encoder is finalized automatically so that any required padding characters are emitted.

Constructor Summary

Constructors

Constructor	Description
BaseEncoderInputStream(File aInputFile, BaseMetrics aBaseMetrics)	Constructs a BaseEncoderInputStream using the given file and the provided base metrics.
BaseEncoderInputStream(InputStream aInputStream, BaseMetrics aBaseMetrics)	Constructs a BaseEncoderInputStream using the given input stream and the provided base metrics.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
boolean	isClosed()	Determines whether this stream has been closed.
int	read()
int	read(byte[] aBuffer, int aOffset, int aLength)

Methods inherited from class InputStream

mark, markSupported, nullInputStream, read, readAllBytes, readNBytes, readNBytes, reset, skip, skipNBytes, transferTo

Methods inherited from class Object

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

Constructor Details

BaseEncoderInputStream

public BaseEncoderInputStream(InputStream aInputStream,
 BaseMetrics aBaseMetrics)
                       throws IOException

Constructs a BaseEncoderInputStream using the given input stream and the provided base metrics.

Parameters:

aInputStream - The input stream providing the decoded data.

aBaseMetrics - The base metrics used to encode the data.

Throws:

IOException - Thrown in case initializing the encoder caused an I/O-related problem.

BaseEncoderInputStream

public BaseEncoderInputStream(File aInputFile,
 BaseMetrics aBaseMetrics)
                       throws IOException

Constructs a BaseEncoderInputStream using the given file and the provided base metrics.

Parameters:

aInputFile - The file providing the decoded data.

aBaseMetrics - The base metrics used to encode the data.

Throws:

IOException - Thrown in case opening the file or initializing the encoder caused an I/O-related problem.

Method Details

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] aBuffer,
 int aOffset,
 int aLength)
         throws IOException

Overrides:

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

isClosed

public boolean isClosed()

Determines whether this stream has been closed.

Returns:

true if this stream has been closed.