org.cryptacular.io

Class EncodingOutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.cryptacular.io.EncodingOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class EncodingOutputStream
extends java.io.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 and Description
private Encoder	encoder Performs decoding.
private java.nio.CharBuffer	output Receives encoding result.
private java.io.OutputStreamWriter	writer Wraps the output stream to convert characters to bytes.

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor and Description
EncodingOutputStream(java.io.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 and Description
static EncodingOutputStream	base64(java.io.OutputStream out) Creates a new instance that produces base64 output in the given stream.
static EncodingOutputStream	base64(java.io.OutputStream out, int lineLength) Creates a new instance that produces base64 output in the given stream.
void	close()
void	flush()
static EncodingOutputStream	hex(java.io.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 Detail

encoder

private final Encoder encoder

Performs decoding.

writer

private final java.io.OutputStreamWriter writer

Wraps the output stream to convert characters to bytes.

output

private java.nio.CharBuffer output

Receives encoding result.

Constructor Detail

EncodingOutputStream

public EncodingOutputStream(java.io.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 Detail

write

public void write(int b)
           throws java.io.IOException

Overrides:

write in class java.io.FilterOutputStream

Throws:

java.io.IOException

write

public void write(byte[] b)
           throws java.io.IOException

Overrides:

write in class java.io.FilterOutputStream

Throws:

java.io.IOException

write

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

Overrides:

write in class java.io.FilterOutputStream

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.FilterOutputStream

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.FilterOutputStream

Throws:

java.io.IOException

base64

public static EncodingOutputStream base64(java.io.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(java.io.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(java.io.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.