kristal.client
Class Base64

java.lang.Object
  extended bykristal.client.Base64

public class Base64
extends java.lang.Object

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.


Nested Class Summary
static class Base64.InputStream
          A { Base64#InputStream} will read data from another { java.io.InputStream}, given in the constructor, and encode/decode to/from Base64 notation on the fly.
static class Base64.OutputStream
          A { Base64#OutputStream} will write data to another { java.io.OutputStream}, given in the constructor, and encode/decode to/from Base64 notation on the fly.
 
Field Summary
static boolean DECODE
          Specify decoding (value is false).
static boolean ENCODE
          Specify encoding (value is true).
static int MAX_LINE_LENGTH
          Maximum line length (76) of Base64 output.
 
Method Summary
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 byte[] decode4to3(byte[] fourBytes)
          Decodes the first four bytes of array fourBytes and returns an array up to three bytes long with the decoded values.
static int decode4to3(byte[] source, int srcOffset, byte[] destination, int destOffset)
          Decodes four bytes from array source and writes the resulting bytes (up to three of them) to destination.
static java.lang.Object decodeToObject(java.lang.String encodedObject)
          Attempts to decode Base64 data and deserialize a Java Object within.
static java.lang.String decodeToString(java.lang.String s)
          Decodes data from Base64 notation and returns it as a string.
static byte[] encode3to4(byte[] threeBytes)
          Encodes the first three bytes of array threeBytes and returns a four-byte array in Base64 notation.
static byte[] encode3to4(byte[] threeBytes, int numSigBytes)
          Encodes up to the first three bytes of array threeBytes and returns a four-byte array in Base64 notation.
static byte[] encode3to4(byte[] source, int srcOffset, int numSigBytes, byte[] destination, int destOffset)
          Encodes up to three bytes of the array source and writes the resulting four Base64 bytes to destination.
static java.lang.String encodeBytes(byte[] source)
          Encodes a byte array into Base64 notation.
static java.lang.String encodeBytes(byte[] source, int off, int len)
          Encodes a byte array into Base64 notation.
static java.lang.String encodeObject(java.io.Serializable serializableObject)
          Serializes an object and returns the Base64-encoded version of that serialized object.
static java.lang.String encodeString(java.lang.String s)
          Encodes a string in Base64 notation with line breaks after every 75 Base64 characters.
static void main(java.lang.String[] args)
          Testing.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

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

MAX_LINE_LENGTH

public static final int MAX_LINE_LENGTH
Maximum line length (76) of Base64 output.

See Also:
Constant Field Values
Method Detail

main

public static void main(java.lang.String[] args)
Testing.


encode3to4

public static byte[] encode3to4(byte[] threeBytes)
Encodes the first three bytes of array threeBytes and returns a four-byte array in Base64 notation.

Parameters:
threeBytes - the array to convert
Returns:
four byte array in Base64 notation.
Since:
1.3

encode3to4

public static byte[] encode3to4(byte[] threeBytes,
                                int numSigBytes)
Encodes up to the first three bytes of array threeBytes and returns a four-byte array in Base64 notation. The actual number of significant bytes in your array is given by numSigBytes. The array threeBytes needs only be as big as numSigBytes.

Parameters:
threeBytes - the array to convert
numSigBytes - the number of significant bytes in your array
Returns:
four byte array in Base64 notation.
Since:
1.3

encode3to4

public static byte[] encode3to4(byte[] source,
                                int srcOffset,
                                int numSigBytes,
                                byte[] destination,
                                int destOffset)
Encodes up to three bytes of the array source and writes the resulting four Base64 bytes to destination. The source and destination arrays can be manipulated anywhere along their length by specifying srcOffset and destOffset. This method does not check to make sure your arrays are large enough to accomodate srcOffset + 3 for the source array or destOffset + 4 for the destination array. The actual number of significant bytes in your array is given by numSigBytes.

Parameters:
source - the array to convert
srcOffset - the index where conversion begins
numSigBytes - the number of significant bytes in your array
destination - the array to hold the conversion
destOffset - the index where output will be put
Returns:
the destination array
Since:
1.3

encodeObject

public static java.lang.String encodeObject(java.io.Serializable serializableObject)
Serializes an object and returns the Base64-encoded version of that serialized object. If the object cannot be serialized or there is another error, the method will return null.

Parameters:
serializableObject - The object to encode
Returns:
The Base64-encoded object
Since:
1.4

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

encodeBytes

public static java.lang.String encodeBytes(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

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.

Parameters:
s - the string to encode
Returns:
the encoded string
Since:
1.3

decode4to3

public static byte[] decode4to3(byte[] fourBytes)
Decodes the first four bytes of array fourBytes and returns an array up to three bytes long with the decoded values.

Parameters:
fourBytes - the array with Base64 content
Returns:
array with decoded values
Since:
1.3

decode4to3

public static int decode4to3(byte[] source,
                             int srcOffset,
                             byte[] destination,
                             int destOffset)
Decodes four bytes from array source and writes the resulting bytes (up to three of them) to destination. The source and destination arrays can be manipulated anywhere along their length by specifying srcOffset and destOffset. This method does not check to make sure your arrays are large enough to accomodate srcOffset + 4 for the source array or destOffset + 3 for the destination array. This method returns the actual number of bytes that were converted from the Base64 encoding.

Parameters:
source - the array to convert
srcOffset - the index where conversion begins
destination - the array to hold the conversion
destOffset - the index where output will be put
Returns:
the number of decoded bytes converted
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

decodeToObject

public static java.lang.Object decodeToObject(java.lang.String encodedObject)
Attempts to decode Base64 data and deserialize a Java Object within. Returns null if there was an error.

Parameters:
encodedObject - The Base64 data to decode
Returns:
The decoded and deserialized object
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