Module seppiko.commons.utils

Package org.seppiko.commons.utils.codec

Class Base32

java.lang.Object

org.seppiko.commons.utils.codec.Base32

All Implemented Interfaces:

Serializable, BaseNCodec

public class Base32
extends Object
implements BaseNCodec, Serializable

Base32 encoding and decoding.

Author:

Leonard Woo

See Also:

• RFC4648 §6
• RFC4648 §7
• Base32
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Base32	RFC4648	The most widely used Base32 alphabet is defined in RFC 4648.
static final Base32	RFC4648_HEX	The most widely used Base32 alphabet is defined in RFC 4648.
static final Base32	ZBASE32	z-base-32 is a Base32 encoding designed by Zooko Wilcox-O'Hearn to be easier for human use and more compact.

Fields inherited from interface org.seppiko.commons.utils.codec.BaseNCodec

BIT_WIDTH, BITS_PER_ENCODED_BYTE, BYTES_PER_ENCODED_BLOCK, MASK_2BITS, MASK_4BITS, MASK_5BITS, MASK_6BITS, MASK_8BITS, MASK_UPPER_4BITS

Method Summary

Modifier and Type	Method	Description
byte[]	decode(String str)	Decode the Base32-encoded data in input and return the data in a new byte array.
String	encodeString(byte[] source)	Base32-encode the given data and return a newly allocated String with the result.

Methods inherited from class java.lang.Object

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

Field Details

RFC4648

public static final Base32 RFC4648

The most widely used Base32 alphabet is defined in RFC 4648. It uses an alphabet of A–Z, followed by 2–7. The digits 0, 1 and 8 are skipped due to their similarity with the letters O, I and B (thus "2" has a decimal value of 26).

RFC4648_HEX

public static final Base32 RFC4648_HEX

The most widely used Base32 alphabet is defined in RFC 4648. It uses a digit of 0-9, followed by A–V.

ZBASE32

public static final Base32 ZBASE32

z-base-32 is a Base32 encoding designed by Zooko Wilcox-O'Hearn to be easier for human use and more compact. It includes 1, 8 and 9 but excludes l, v and 2. It also permutes the alphabet so that the easier characters are the ones that occur more frequently.

See Also:

• human-oriented base-32 encoding

Method Details

encodeString

public String encodeString(byte[] source)

Base32-encode the given data and return a newly allocated String with the result.

Specified by:

encodeString in interface BaseNCodec

Parameters:

source - the data to encode.

Returns:

a newly allocated String with the result.

Throws:

NullPointerException - data is null.

decode

public byte[] decode(String str)
              throws IllegalArgumentException,
NullPointerException

Decode the Base32-encoded data in input and return the data in a new byte array.

Specified by:

decode in interface BaseNCodec

Parameters:

str - the data to decode.

Returns:

the data in a new byte array.

Throws:

IllegalArgumentException - data is not divisible by 8.

NullPointerException - data is null.