Package org.cryptacular.io

Class EncodingOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.cryptacular.io.EncodingOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class EncodingOutputStream
extends FilterOutputStream

Filters written bytes through an Encoder such that encoded data is written to the underlying output stream.

Field Summary

Fields

Modifier and Type	Field	Description
private final Encoder	encoder	Performs decoding.
private CharBuffer	output	Receives encoding result.
private final OutputStreamWriter	writer	Wraps the output stream to convert characters to bytes.

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
EncodingOutputStream(OutputStream out, Encoder e)	Creates a new instance that wraps the given stream and performs encoding using the given encoder component.

Method Summary

Modifier and Type	Method	Description
static EncodingOutputStream	base64(OutputStream out)	Creates a new instance that produces base64 output in the given stream.
static EncodingOutputStream	base64(OutputStream out, int lineLength)	Creates a new instance that produces base64 output in the given stream.
void	close()
void	flush()
static EncodingOutputStream	hex(OutputStream out)	Creates a new instance that produces hexadecimal output in the given stream.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Field Details

encoder

private final Encoder encoder

Performs decoding.

writer

private final OutputStreamWriter writer

Wraps the output stream to convert characters to bytes.

output

private CharBuffer output

Receives encoding result.

Constructor Details

EncodingOutputStream

public EncodingOutputStream(OutputStream out,
 Encoder e)

Creates a new instance that wraps the given stream and performs encoding using the given encoder component.

Parameters:

out - Output stream to wrap.

e - Encoder that provides on-the-fly encoding.

Method Details

write

public void write(int b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

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

Overrides:

write in class FilterOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

base64

public static EncodingOutputStream base64(OutputStream out)

Creates a new instance that produces base64 output in the given stream.

NOTE: there are no line breaks in the output with this version.

Parameters:

out - Wrapped output stream.

Returns:

Encoding output stream that produces base64 output.

base64

public static EncodingOutputStream base64(OutputStream out,
 int lineLength)

Creates a new instance that produces base64 output in the given stream.

NOTE: this version supports output with configurable line breaks.

Parameters:

out - Wrapped output stream.

lineLength - Length of each base64-encoded line in output. A zero or negative value disables line breaks.

Returns:

Encoding output stream that produces base64 output.

hex

public static EncodingOutputStream hex(OutputStream out)

Creates a new instance that produces hexadecimal output in the given stream.

NOTE: there are no line breaks in the output.

Parameters:

out - Wrapped output stream.

Returns:

Encoding output stream that produces hexadecimal output.