jsimple.util

Class Base64

java.lang.Object

jsimple.util.Base64

public class Base64
extends java.lang.Object

Provides Base64 encoding and decoding as defined by RFC 2045.

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.

Since this class operates directly on byte streams, and not character streams, it is hard-coded to only encode/decode character encodings which are compatible with the lower 127 ASCII chart (ISO-8859-1, Windows-1252, UTF-8, etc).

Since:

2.2

See Also:

RFC 2045

Constructor Summary

Constructors

Constructor and Description
Base64() Creates a Base64 codec.

Method Summary

Modifier and Type	Method and Description
byte[]	decode(byte[] pArray) Decodes a byte[] containing containing characters in the Base64 alphabet.
byte[]	decode(java.lang.String pArray) Decodes a String containing containing characters in the Base64 alphabet.
static byte[]	decodeBase64(byte[] base64Data) Decodes Base64 data into octets
static byte[]	decodeBase64(java.lang.String base64String) Decodes a Base64 String into octets
byte[]	encode(byte[] pArray) Encodes a byte[] containing binary data, into a byte[] containing characters in the Base64 alphabet.
static byte[]	encodeBase64(byte[] binaryData) Encodes binary data using the base64 algorithm.
static java.lang.String	encodeBase64String(byte[] binaryData) Encodes binary data using the base64 algorithm.
static boolean	isBase64(byte octet) Returns whether or not the octet is in the base 64 alphabet.

Methods inherited from class java.lang.Object

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

Constructor Detail

Base64

public Base64()

Creates a Base64 codec.

Since:

1.4

Method Detail

isBase64

public static boolean isBase64(byte octet)

Returns whether or not the octet is in the base 64 alphabet.

Parameters:

octet - The value to test

Returns:

true if the value is defined in the the base 64 alphabet, false otherwise.

Since:

1.4

encodeBase64String

public static java.lang.String encodeBase64String(byte[] binaryData)

Encodes binary data using the base64 algorithm.

Parameters:

binaryData - binary data to encode

Returns:

String containing Base64 characters.

Since:

3.2

encodeBase64

public static byte[] encodeBase64(byte[] binaryData)

Encodes binary data using the base64 algorithm.

Parameters:

binaryData - Array containing binary data to encode.

Returns:

Base64-encoded data.

Throws:

java.lang.IllegalArgumentException - Thrown when the input array needs an output array bigger than maxResultSize

Since:

1.4

decodeBase64

public static byte[] decodeBase64(java.lang.String base64String)

Decodes a Base64 String into octets

Parameters:

base64String - String containing Base64 data

Returns:

Array containing decoded data.

Since:

1.4

decodeBase64

public static byte[] decodeBase64(byte[] base64Data)

Decodes Base64 data into octets

Parameters:

base64Data - Byte array containing Base64 data

Returns:

Array containing decoded data.

decode

public byte[] decode(java.lang.String pArray)

Decodes a String containing containing characters in the Base64 alphabet.

Parameters:

pArray - A String containing Base64 character data

Returns:

a byte array containing binary data

Since:

1.4

decode

public byte[] decode(byte[] pArray)

Decodes a byte[] containing containing characters in the Base64 alphabet.

Parameters:

pArray - A byte array containing Base64 character data

Returns:

a byte array containing binary data

encode

public byte[] encode(byte[] pArray)

Encodes a byte[] containing binary data, into a byte[] containing characters in the Base64 alphabet.

Parameters:

pArray - a byte array containing binary data

Returns:

A byte array containing only Base64 character data