anon.util

Class Base64

java.lang.Object

anon.util.Base64

public final class Base64
extends java.lang.Object

Encodes and decodes to and from Base64 notation.

Change Log:

• v1.4 - Added helper methods to read/write files.
• v1.3.6 - Fixed OutputStream.flush() so that 'position' is reset.
• v1.3.5 - Added flag to turn on and off line breaks. Fixed bug in input stream where last buffer being read, if not completely full, was not returned.
• v1.3.4 - Fixed when "improperly padded stream" error was thrown at the wrong time.
• v1.3.3 - Fixed I/O streams which were totally messed up.

I am placing this code in the Public Domain. Do with it as you will. This software comes with no guarantees or warranties but with plenty of well-wishing instead! Please visit http://iharder.net/xmlizable periodically to check for updates or to contribute improvements.

Version:

1.4

Author:

Robert Harder, rob@iharder.net

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEGIN_TAG
static boolean	COMPRESS Specify that data should be compressed (value is true).
static boolean	DECODE Specify decoding (value is false).
static boolean	DONT_COMPRESS Specify that data should not be compressed (value is false).
static boolean	ENCODE Specify encoding (value is true).
static java.lang.String	END_TAG
static java.lang.String	TAG_END_SEQUENCE

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createBeginTag(java.lang.String strBase64TagName) Creates the begin tag for a base 64 encoded string.
static java.lang.String	createEndTag(java.lang.String strBase64TagName) Creates the end tag for a base 64 encoded string.
static byte[]	decode(byte[] source, int off, int len) Decodes Base64 content in byte array format and returns the decoded byte array.
static byte[]	decode(java.lang.String s) Decodes data from Base64 notation.
static java.lang.String	decodeToString(java.lang.String s) Decodes data from Base64 notation and returns it as a string.
static java.lang.String	encode(byte[] source, boolean breakLines) Encodes a byte array into Base64 notation.
static java.lang.String	encode(byte[] source, int off, int len) Encodes a byte array into Base64 notation.
static java.lang.String	encode(byte[] source, int off, int len, boolean breakLines) Encodes a byte array into Base64 notation.
static java.lang.String	encodeBytes(byte[] source) Encodes a byte array into Base64 notation.
static java.lang.String	encodeString(java.lang.String s) Encodes a string in Base64 notation with line breaks after every 75 Base64 characters.
static java.lang.String	encodeString(java.lang.String s, boolean breakLines) Encodes a string in Base64 notation with line breaks after every 75 Base64 characters.

Methods inherited from class java.lang.Object

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

Field Detail

BEGIN_TAG

public static final java.lang.String BEGIN_TAG

See Also:

Constant Field Values

END_TAG

public static final java.lang.String END_TAG

See Also:

Constant Field Values

TAG_END_SEQUENCE

public static final java.lang.String TAG_END_SEQUENCE

See Also:

Constant Field Values

ENCODE

public static final boolean ENCODE

Specify encoding (value is true).

See Also:

Constant Field Values

DECODE

public static final boolean DECODE

Specify decoding (value is false).

See Also:

Constant Field Values

COMPRESS

public static final boolean COMPRESS

Specify that data should be compressed (value is true).

See Also:

Constant Field Values

DONT_COMPRESS

public static final boolean DONT_COMPRESS

Specify that data should not be compressed (value is false).

See Also:

Constant Field Values

Method Detail

createBeginTag

public static java.lang.String createBeginTag(java.lang.String strBase64TagName)

Creates the begin tag for a base 64 encoded string.

Parameters:

strBase64TagName - the base 64 tag name

Returns:

the begin tag for a base 64 encoded string

createEndTag

public static java.lang.String createEndTag(java.lang.String strBase64TagName)

Creates the end tag for a base 64 encoded string.

Parameters:

strBase64TagName - the base 64 tag name

Returns:

the end tag for a base 64 encoded string

encodeBytes

public static java.lang.String encodeBytes(byte[] source)

Encodes a byte array into Base64 notation. Equivalen to calling encodeBytes( source, 0, source.length )

Parameters:

source - The data to convert

Since:

1.4

encode

public static java.lang.String encode(byte[] source,
                                      boolean breakLines)

Encodes a byte array into Base64 notation. Equivalen to calling encodeBytes( source, 0, source.length )

Parameters:

source - The data to convert

breakLines - Break lines at 80 characters or less.

Returns:

the encoded bytes or null

Since:

1.4

encode

public static java.lang.String encode(byte[] source,
                                      int off,
                                      int len)

Encodes a byte array into Base64 notation.

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

Since:

1.4

encode

public static java.lang.String encode(byte[] source,
                                      int off,
                                      int len,
                                      boolean breakLines)

Encodes a byte array into Base64 notation.

Parameters:

source - The data to convert

off - Offset in array where conversion should begin

len - Length of data to convert

breakLines - Break lines at 80 characters or less.

Since:

1.4

encodeString

public static java.lang.String encodeString(java.lang.String s)

Encodes a string in Base64 notation with line breaks after every 75 Base64 characters. Of course you probably only need to encode a string if there are non-ASCII characters in it such as many non-English languages.

Parameters:

s - the string to encode

Returns:

the encoded string

Since:

1.3

encodeString

public static java.lang.String encodeString(java.lang.String s,
                                            boolean breakLines)

Encodes a string in Base64 notation with line breaks after every 75 Base64 characters. Of course you probably only need to encode a string if there are non-ASCII characters in it such as many non-English languages.

Parameters:

s - the string to encode

breakLines - Break lines at 80 characters or less.

Returns:

the encoded string or null

Since:

1.3

decode

public static byte[] decode(java.lang.String s)

Decodes data from Base64 notation.

Parameters:

s - the string to decode

Returns:

the decoded data

Since:

1.4

decodeToString

public static java.lang.String decodeToString(java.lang.String s)

Decodes data from Base64 notation and returns it as a string. Equivlaent to calling new String( decode( s ) )

Parameters:

s - the strind to decode

Returns:

The data as a string

Since:

1.4

decode

public static byte[] decode(byte[] source,
                            int off,
                            int len)

Decodes Base64 content in byte array format and returns the decoded byte array.

Parameters:

source - The Base64 encoded data

off - The offset of where to begin decoding

len - The length of characters to decode

Returns:

decoded data

Since:

1.3