org.apache.james.mime4j.codec

Class Base64OutputStream

java.lang.Object

java.io.OutputStream

org.apache.james.mime4j.codec.Base64OutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class Base64OutputStream
extends OutputStream

This class implements section 6.8. Base64 Content-Transfer-Encoding from RFC 2045 Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies by Freed and Borenstein.

Code is based on Base64 and Base64OutputStream code from Commons-Codec 1.4.

See Also:

RFC 2045

Constructor Summary

Constructors

Constructor and Description
Base64OutputStream(OutputStream out) Creates a Base64OutputStream that writes the encoded data to the given output stream using the default line length (76) and line separator (CRLF).
Base64OutputStream(OutputStream out, int lineLength) Creates a Base64OutputStream that writes the encoded data to the given output stream using the given line length and the default line separator (CRLF).
Base64OutputStream(OutputStream out, int lineLength, byte[] lineSeparator) Creates a Base64OutputStream that writes the encoded data to the given output stream using the given line length and line separator.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int i)

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64OutputStream

public Base64OutputStream(OutputStream out)

Creates a Base64OutputStream that writes the encoded data to the given output stream using the default line length (76) and line separator (CRLF).

Parameters:

out - underlying output stream.

Base64OutputStream

public Base64OutputStream(OutputStream out,
                          int lineLength)

Creates a Base64OutputStream that writes the encoded data to the given output stream using the given line length and the default line separator (CRLF).

The given line length will be rounded up to the nearest multiple of 4. If the line length is zero then the output will not be split into lines.

Parameters:

out - underlying output stream.

lineLength - desired line length.

Base64OutputStream

public Base64OutputStream(OutputStream out,
                          int lineLength,
                          byte[] lineSeparator)

Creates a Base64OutputStream that writes the encoded data to the given output stream using the given line length and line separator.

The given line length will be rounded up to the nearest multiple of 4. If the line length is zero then the output will not be split into lines and the line separator is ignored.

The line separator must not include characters from the BASE64 alphabet (including the padding character =).

Parameters:

out - underlying output stream.

lineLength - desired line length.

lineSeparator - line separator to use.

Method Detail

write

public void write(int i)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

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

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException