org.kocakosm.pitaya.util

Class BaseEncoding

java.lang.Object

org.kocakosm.pitaya.util.BaseEncoding

public final class BaseEncoding
extends Object

RFC 4648 encoding scheme. Instances of this class are immutable.

Author:

Osman KOCAK

See Also:

RFC 4648

Field Summary

Fields

Modifier and Type	Field and Description
static BaseEncoding	BASE_16 Base16 encoding scheme.
static BaseEncoding	BASE_32 Base32 encoding scheme.
static BaseEncoding	BASE_32_HEX Base32 encoding scheme with extended Hex alphabet.
static BaseEncoding	BASE_64 Base64 encoding scheme.
static BaseEncoding	BASE_64_URL Base64 encoding scheme with URL and filename safe alphabet.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	decode(String in) Decodes the given encoded String according to this BaseEncoding's configuration.
byte[]	decode(String in, int off, int len) Decodes the specified range from the given encoded String according to this BaseEncoding's configuration.
String	encode(byte... in) Encodes the given data bytes according to this BaseEncoding's configuration.
String	encode(byte[] in, int off, int len) Encodes the given data bytes according to this BaseEncoding's configuration.
BaseEncoding	ignoreUnknownCharacters() Returns a BaseEncoding that behaves as this one except that it ignores any unknown character when decoding encoded data.
BaseEncoding	withoutPadding() Returns a BaseEncoding that behaves as this one except that it doesn't append padding when encoding data and treats any padding character as an unknown character when decoding encoded data.
BaseEncoding	withSeparator(String separator, int n) Returns a BaseEncoding that behaves as this one except that it adds the specified separator after every n characters when encoding data and ignores any occurence of the specified separator when decoding encoded data.

Methods inherited from class java.lang.Object

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

Field Detail

BASE_64

public static final BaseEncoding BASE_64

Base64 encoding scheme.

BASE_64_URL

public static final BaseEncoding BASE_64_URL

Base64 encoding scheme with URL and filename safe alphabet.

BASE_32

public static final BaseEncoding BASE_32

Base32 encoding scheme.

BASE_32_HEX

public static final BaseEncoding BASE_32_HEX

Base32 encoding scheme with extended Hex alphabet.

BASE_16

public static final BaseEncoding BASE_16

Base16 encoding scheme.

Method Detail

withSeparator

public BaseEncoding withSeparator(String separator,
                         int n)

Returns a BaseEncoding that behaves as this one except that it adds the specified separator after every n characters when encoding data and ignores any occurence of the specified separator when decoding encoded data. See RFC 4648 section 3.1 for more details.

Parameters:

separator - the separator to use.

n - the number of characters between two successive separators.

Returns:

a BaseEncoding with the desired configuration.

Throws:

NullPointerException - if separator is null.

IllegalArgumentException - if separator contains any alphabet or padding characters or if n <= 0.

withoutPadding

public BaseEncoding withoutPadding()

Returns a BaseEncoding that behaves as this one except that it doesn't append padding when encoding data and treats any padding character as an unknown character when decoding encoded data. Also, note that since Base16 encoding scheme does not need padding, it is not affected by this method call. See RFC 4648 section 3.2 for more details.

Returns:

a BaseEncoding with the desired configuration.

ignoreUnknownCharacters

public BaseEncoding ignoreUnknownCharacters()

Returns a BaseEncoding that behaves as this one except that it ignores any unknown character when decoding encoded data. See RFC 4648 section 3.3 for more details.

Returns:

a BaseEncoding with the desired configuration.

encode

public String encode(byte... in)

Encodes the given data bytes according to this BaseEncoding's configuration.

Parameters:

in - the data bytes to encode.

Returns:

the encoded String.

Throws:

NullPointerException - if in is null.

encode

public String encode(byte[] in,
            int off,
            int len)

Encodes the given data bytes according to this BaseEncoding's configuration.

Parameters:

in - the input buffer.

off - the input offset.

len - the number of bytes to encode.

Returns:

the encoded String.

Throws:

NullPointerException - if in is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than in's length.

decode

public byte[] decode(String in)

Decodes the given encoded String according to this BaseEncoding's configuration. Decoding is not case-sensitive when possible (namely for Base16, Base32 and Base32Hex schemes).

Parameters:

in - the input String.

Returns:

the decoded data.

Throws:

NullPointerException - if in is null.

IllegalArgumentException - if in is not a valid base-encoded String according to this BaseEncoding's configuration.

decode

public byte[] decode(String in,
            int off,
            int len)

Decodes the specified range from the given encoded String according to this BaseEncoding's configuration. Decoding is not case-sensitive when possible (namely for Base16, Base32 and Base32Hex schemes).

Parameters:

in - the input String.

off - the input offset.

len - the number of characters to decode.

Returns:

the decoded data.

Throws:

NullPointerException - if in is null.

IndexOutOfBoundsException - if off or len is negative or if off + len is greater than in's length.

IllegalArgumentException - if the specified character range in in is not a valid base-encoded String according to this BaseEncoding's configuration.