Module org.refcodes.codec

Package org.refcodes.codec

Class BaseEncoderOutputStream

java.lang.Object

java.io.OutputStream

org.refcodes.codec.BaseEncoderOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class BaseEncoderOutputStream
extends OutputStream

The BaseEncoderOutputStream is an implementations of the BaseEncoder interface to be used with OutputStream instances. Make sure to call close() when done as the final padding bytes are appended to the end!

Constructor Summary

Constructors

Constructor	Description
BaseEncoderOutputStream(File aOutputFile, BaseMetrics aBaseMetrics)	Constructs a BaseEncoderOutputStream using the given File from which to read decoded data and using the BaseMetrics to encode the data.
BaseEncoderOutputStream(OutputStream aOutputStream, BaseMetrics aBaseMetrics)	Constructs a BaseEncoderOutputStream using the given OutputStream from which to read decoded data and using the BaseMetrics to encode the data.

Method Summary

Modifier and Type	Method	Description
void	close()	Make sure to call close() when done as the final padding bytes are appended to the end!
void	flush()
void	write(int aByte)

Methods inherited from class java.io.OutputStream

nullOutputStream, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseEncoderOutputStream

public BaseEncoderOutputStream(OutputStream aOutputStream,
                               BaseMetrics aBaseMetrics)
                        throws IOException

Constructs a BaseEncoderOutputStream using the given OutputStream from which to read decoded data and using the BaseMetrics to encode the data.

Parameters:

aOutputStream - The OutputStream from which to read decoded data.

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

Throws:

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

BaseEncoderOutputStream

public BaseEncoderOutputStream(File aOutputFile,
                               BaseMetrics aBaseMetrics)
                        throws IOException

Constructs a BaseEncoderOutputStream using the given File from which to read decoded data and using the BaseMetrics to encode the data.

Parameters:

aOutputFile - The File from which to read decoded data.

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

Throws:

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

Method Detail

write

public void write(int aByte)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Make sure to call close() when done as the final padding bytes are appended to the end!

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException