net.sf.kdgcommons.codec

Class Base64Codec

java.lang.Object

net.sf.kdgcommons.codec.Codec

net.sf.kdgcommons.codec.Base64Codec

public class Base64Codec
extends Codec

Converts binary data to/from a string consisting of base-64 characters.

There are several standard options for string conversion line breaks, defined by the #Option enum. You can also specify your own breaks and maximum line length.

Conversion to byte arrays always ignores whitespace, and will also ignore any specified start/end/separation strings (the separation string may appear any where in the source string, the start/end strings must appear in their respective locations).

Since:

1.0.14

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Base64Codec.Option Different standard construction options: each value specifies a combination of maximum line length and separator characters.

Field Summary

Fields inherited from class net.sf.kdgcommons.codec.Codec

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
Base64Codec() Default constructor; equivalent to using #Option.UNBROKEN.
Base64Codec(Base64Codec.Option option) Constructs an instance using standard parameters.
Base64Codec(int lineLength, byte[] separator) Creates an instance that uses standard encoding, but custom line length and separator.
Base64Codec(int lineLength, String separator) Creates an instance with custom line length and separator, where the separator is specified as a string (and converted via UTF-8).

Method Summary

Modifier and Type	Method and Description
void	decode(InputStream in, OutputStream out) Decodes a stream according to the rules of the codec.
void	encode(InputStream in, OutputStream out) Encodes a stream according to the rules of the codec.
byte[]	toBytes(String str) Decodes the passed string and returns it as a byte array.
String	toString(byte[] data) Encodes the passed array and returns it as a string.

Methods inherited from class net.sf.kdgcommons.codec.Codec

decode, decode, encode, encode, nextNonWhitespace, skipIfSeparator, wrapIfNeeded

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64Codec

public Base64Codec()

Default constructor; equivalent to using #Option.UNBROKEN.

Base64Codec

public Base64Codec(Base64Codec.Option option)

Constructs an instance using standard parameters.

Base64Codec

public Base64Codec(int lineLength,
                   String separator)

Creates an instance with custom line length and separator, where the separator is specified as a string (and converted via UTF-8).

Base64Codec

public Base64Codec(int lineLength,
                   byte[] separator)

Creates an instance that uses standard encoding, but custom line length and separator.

Method Detail

encode

public void encode(InputStream in,
                   OutputStream out)

Description copied from class: Codec

Encodes a stream according to the rules of the codec.

Specified by:

encode in class Codec

decode

public void decode(InputStream in,
                   OutputStream out)

Description copied from class: Codec

Decodes a stream according to the rules of the codec.

Specified by:

decode in class Codec

toString

public String toString(byte[] data)

Encodes the passed array and returns it as a string.

toBytes

public byte[] toBytes(String str)

Decodes the passed string and returns it as a byte array.