Package org.mozilla.jss.util

Class Base64OutputStream

java.lang.Object

java.io.OutputStream

java.io.FilterOutputStream

org.mozilla.jss.util.Base64OutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class Base64OutputStream
extends FilterOutputStream

An output stream filter that takes arbitrary bytes and outputs their base64 encoding. Call flush() or close() to write out the final padding. The class also automatically puts line breaks in the output stream.

Field Summary

Fields

Modifier and Type	Field	Description
private short	charsOnLine
private int	charsPerLine
private static final int	DEFAULT_QUADS_PER_LINE
private boolean	doLineBreaks
private static final char[]	encoding
private byte[]	input
private short	inputCount

Fields inherited from class java.io.FilterOutputStream

out

Constructor Summary

Constructors

Constructor	Description
Base64OutputStream(PrintStream out)	Create a stream that does not insert line breaks.
Base64OutputStream(PrintStream out, int quadsPerLine)

Method Summary

Modifier and Type	Method	Description
void	close()	This flushes the stream and closes the next stream downstream.
void	flush()	Calling this will put the ending padding on the base64 stream, so don't call it until you have no data left.
private void	outputOneAtom()	Output 3 bytes of input as 4 bytes of base-64 encoded output.
void	write(byte[] buffer)
void	write(byte[] buffer, int offset, int count)
void	write(int oneByte)

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

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

Field Details

encoding

private static final char[] encoding

input

private byte[] input

inputCount

private short inputCount

charsOnLine

private short charsOnLine

charsPerLine

private int charsPerLine

DEFAULT_QUADS_PER_LINE

private static final int DEFAULT_QUADS_PER_LINE

See Also:

• Constant Field Values

doLineBreaks

private boolean doLineBreaks

Constructor Details

Base64OutputStream

public Base64OutputStream(PrintStream out)

Create a stream that does not insert line breaks. To have line breaks, use the other constructor.

Base64OutputStream

public Base64OutputStream(PrintStream out,
 int quadsPerLine)

Parameters:

quadsPerLine - Number of 4-character blocks to write before outputting a line break. For example, for 76-characters per line, pass in 76/4 = 19.

Method Details

write

public void write(int oneByte)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

close

public void close()
           throws IOException

This flushes the stream and closes the next stream downstream.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class FilterOutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Calling this will put the ending padding on the base64 stream, so don't call it until you have no data left. The class does no unnecessary buffering, so you probably shouldn't call it at all.

Specified by:

flush in interface Flushable

Overrides:

flush in class FilterOutputStream

Throws:

IOException

write

public void write(byte[] buffer)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

write

public void write(byte[] buffer,
 int offset,
 int count)
           throws IOException

Overrides:

write in class FilterOutputStream

Throws:

IOException

outputOneAtom

private void outputOneAtom()
                    throws IOException

Output 3 bytes of input as 4 bytes of base-64 encoded output. If there are fewer than 3 bytes available, the output will be padded according to the spec. Padding should only happen at the end of the stream.

Throws:

IOException