org.snf4j.core.util

Class Base64Util

java.lang.Object

org.snf4j.core.util.Base64Util

public final class Base64Util
extends Object

A class with Base64 utility functions.

Author:

SNF4J.ORG

Method Summary

Modifier and Type	Method and Description
static byte[]	decode(byte[] data) Decodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme.
static byte[]	decode(byte[] data, boolean isMime) Decodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme with an option for the MIME format.
static byte[]	decode(byte[] data, int offset, int length, boolean isMime) Decodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme with an option for the MIME format.
static byte[]	decode(String data, Charset charset) Decodes a Base64 encoded String into a newly-allocated byte array using the Base64 encoding scheme.
static byte[]	decode(String data, Charset charset, boolean isMime) Decodes a Base64 encoded String into a newly-allocated byte array using the Base64 encoding scheme with an option for the MIME format.
static byte[]	encode(byte[] data) Encodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme.
static String	encode(byte[] data, Charset charset) Encodes the specified byte array into a String using the Base64 encoding scheme.
static byte[]	encode(byte[] data, int offset, int length) Encodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme.
static String	encode(byte[] data, int offset, int length, Charset charset) Encodes the specified byte array into a String using the Base64 encoding scheme.

Methods inherited from class java.lang.Object

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

Method Detail

encode

public static byte[] encode(byte[] data)

Encodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme.

It uses "The Base 64 Alphabet" as specified in Table 1 of RFC 4648.

Parameters:

data - the byte array to encode

Returns:

A newly-allocated byte array containing the resulting encoded bytes

encode

public static String encode(byte[] data,
                            Charset charset)

Encodes the specified byte array into a String using the Base64 encoding scheme.

It first encodes input bytes into a base64 encoded byte array by calling the encode(byte[]) method and then constructs a new String by using the encoded byte array and the specified charset.

Parameters:

data - the byte array to encode

charset - the charset used to encode the resulting String

Returns:

A String containing the resulting Base64 encoded characters

encode

public static byte[] encode(byte[] data,
                            int offset,
                            int length)

Encodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme.

It uses "The Base 64 Alphabet" as specified in Table 1 of RFC 4648.

Parameters:

data - the byte array to encode

offset - offset within the array of the first byte to be encoded

length - number of bytes to be encoded

Returns:

A newly-allocated byte array containing the resulting encoded bytes

encode

public static String encode(byte[] data,
                            int offset,
                            int length,
                            Charset charset)

Encodes the specified byte array into a String using the Base64 encoding scheme.

It first encodes input bytes into a base64 encoded byte array by calling the encode(byte[]) method and then constructs a new String by using the encoded byte array and the specified charset.

Parameters:

data - the byte array to encode

offset - offset within the array of the first byte to be encoded

length - number of bytes to be encoded

charset - the charset used to encode the resulting String

Returns:

A String containing the resulting Base64 encoded characters

decode

public static byte[] decode(byte[] data)

Decodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme.

It uses "The Base 64 Alphabet" as specified in Table 1 of RFC 4648.

Parameters:

data - the byte array to decode

Returns:

A newly-allocated byte array containing the resulting decoded bytes

Throws:

IllegalArgumentException - - if the data is not in valid Base64 scheme

decode

public static byte[] decode(byte[] data,
                            boolean isMime)

Decodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme with an option for the MIME format.

It uses "The Base 64 Alphabet" as specified in Table 1 of RFC 4648.

Parameters:

data - the byte array to decode

isMime - true if the data is encoded in the MIME format

Returns:

A newly-allocated byte array containing the resulting decoded bytes, or null if the data is not in valid Base64 scheme

decode

public static byte[] decode(String data,
                            Charset charset)

Decodes a Base64 encoded String into a newly-allocated byte array using the Base64 encoding scheme.

It first decodes the Base64 encoded String into a sequence of bytes using the given charset and then decode the bytes by calling the decode(byte[]) method.

Parameters:

data - the string to decode

charset - The charset to be used to encode the String

Returns:

A newly-allocated byte array containing the resulting decoded bytes, or null if the data is not in valid Base64 scheme

decode

public static byte[] decode(String data,
                            Charset charset,
                            boolean isMime)

Decodes a Base64 encoded String into a newly-allocated byte array using the Base64 encoding scheme with an option for the MIME format.

It first decodes the Base64 encoded String into a sequence of bytes using the given charset and then decode the bytes by calling the decode(byte[]) method.

Parameters:

data - the string to decode

isMime - true if the data is encoded in the MIME format

charset - The charset to be used to encode the String

Returns:

A newly-allocated byte array containing the resulting decoded bytes, or null if the data is not in valid Base64 scheme

decode

public static byte[] decode(byte[] data,
                            int offset,
                            int length,
                            boolean isMime)

Decodes bytes from the specified byte array into a newly-allocated byte array using the Base64 encoding scheme with an option for the MIME format.

It uses "The Base 64 Alphabet" as specified in Table 1 of RFC 4648.

Parameters:

data - the byte array to decode

offset - offset within the array of the first byte to be decoded

length - number of bytes to be encoded

isMime - true if the data is encoded in the MIME format

Returns:

A newly-allocated byte array containing the resulting decoded bytes, or null if the data is not in valid Base64 scheme