Module org.refcodes.codec

Package org.refcodes.codec

Class BaseDecoderInputStream

java.lang.Object

java.io.InputStream

org.refcodes.codec.BaseDecoderInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class BaseDecoderInputStream
extends InputStream

InputStream decoding data being read.

Constructor Summary

Constructors

Constructor	Description
BaseDecoderInputStream(File aInputFile, BaseMetrics aBaseMetrics)	Constructs a BaseDecoderInputStream using the given File from which to read encoded data and using the BaseMetrics to decode the data.
BaseDecoderInputStream(InputStream aInputStream, BaseMetrics aBaseMetrics)	Constructs a BaseDecoderInputStream using the given InputStream from which to read encoded data and using the BaseMetrics to decode the data.
BaseDecoderInputStream(InputStream aInputStream, BaseMetrics aBaseMetrics, boolean isFilterWhiteSpaces)	Constructs a BaseDecoderInputStream using the given InputStream from which to read encoded data and using the BaseMetrics to decode the data.

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
int	read()

Methods inherited from class java.io.InputStream

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseDecoderInputStream

public BaseDecoderInputStream(InputStream aInputStream,
                              BaseMetrics aBaseMetrics)
                       throws IOException

Constructs a BaseDecoderInputStream using the given InputStream from which to read encoded data and using the BaseMetrics to decode the data.

Parameters:

aInputStream - The InputStream from which to read encoded data.

aBaseMetrics - The BaseMetrics to use to decode the encoded data.

Throws:

IOException - throw in case using the InputStream caused I/O related problems.

BaseDecoderInputStream

public BaseDecoderInputStream(InputStream aInputStream,
                              BaseMetrics aBaseMetrics,
                              boolean isFilterWhiteSpaces)
                       throws IOException

Constructs a BaseDecoderInputStream using the given InputStream from which to read encoded data and using the BaseMetrics to decode the data.

Parameters:

aInputStream - The InputStream from which to read encoded data.

aBaseMetrics - The BaseMetrics to use to decode the encoded data.

isFilterWhiteSpaces - When true, then all white spaces not found in the BaseMetrics.getCharSet() are filtered from the InputStream.

Throws:

IOException - throw in case using the InputStream caused I/O related problems.

BaseDecoderInputStream

public BaseDecoderInputStream(File aInputFile,
                              BaseMetrics aBaseMetrics)
                       throws IOException

Constructs a BaseDecoderInputStream using the given File from which to read encoded data and using the BaseMetrics to decode the data.

Parameters:

aInputFile - The File from which to read encoded data.

aBaseMetrics - The BaseMetrics to use to decode the encoded data.

Throws:

IOException - throw in case using the InputStream caused I/O related problems.

Method Detail

read

public int read()
         throws IOException

Specified by:

read 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

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException