com.github.f4b6a3.ulid.util

Class Base32Util

java.lang.Object

com.github.f4b6a3.ulid.util.Base32Util

public class Base32Util
extends Object

This class contain static methods for encoding to and from Base 32. Supported alphabets: base32, base32hex, zbase32 and crockford base32. RFC-4648: https://tools.ietf.org/html/rfc4648 Wikipedia: https://en.wikipedia.org/wiki/Base32

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Base32Util.Base32UtilException

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALPHABET_BASE_32
static String	ALPHABET_BASE_32_CROCKFORD
static String	ALPHABET_BASE_32_HEX
static String	ALPHABET_BASE_32_Z

Method Summary

Modifier and Type	Method and Description
static byte[]	decode(String string, char[] alphabet, Character padding) Decode a base 32 string into an byte array.
static BigInteger	decodeBigInteger(String string, char[] alphabet) Decode a base 32 string to a BigInteger.
static long	decodeLong(String string, char[] alphabet) Decode a base 32 string to a long number.
static String	encode(byte[] bytes, char[] alphabet, Character padding) Encode an array of bytes into a base 32 string.
static String	encodeBigInteger(BigInteger number, char[] alphabet) Encode a BigInteger to base 32 string.
static String	encodeLong(long number, char[] alphabet) Encode a long number to base 32 string.
static byte[]	fromBase32(String string)
static BigInteger	fromBase32AsBigInteger(String string)
static long	fromBase32AsLong(String string)
static String	fromBase32AsString(String string)
static byte[]	fromBase32Crockford(String string)
static BigInteger	fromBase32CrockfordAsBigInteger(String string)
static long	fromBase32CrockfordAsLong(String string)
static String	fromBase32CrockfordAsString(String string)
static byte[]	fromBase32Hex(String string)
static BigInteger	fromBase32HexAsBigInteger(String string)
static long	fromBase32HexAsLong(String string)
static String	fromBase32HexAsString(String string)
static byte[]	fromBase32Z(String string)
static BigInteger	fromBase32ZAsBigInteger(String string)
static long	fromBase32ZAsLong(String string)
static String	fromBase32ZAsString(String string)
protected static String	normalize(String string)
protected static String	normalizeCrockford(String string)
protected static String	normalizeZ(String string)
static String	toBase32(BigInteger number)
static String	toBase32(byte[] bytes)
static String	toBase32(long number)
static String	toBase32(String string)
static String	toBase32Crockford(BigInteger number)
static String	toBase32Crockford(byte[] bytes)
static String	toBase32Crockford(long number)
static String	toBase32Crockford(String string)
static String	toBase32Hex(BigInteger number)
static String	toBase32Hex(byte[] bytes)
static String	toBase32Hex(long number)
static String	toBase32Hex(String string)
static String	toBase32Z(BigInteger number)
static String	toBase32Z(byte[] bytes)
static String	toBase32Z(long number)
static String	toBase32Z(String string)
static byte[]	toBytes(String string) Convert a string to an array of bytes using UTF-8.
static String	toString(byte[] bytes) Convert an array of bytes to a string using UTF-8.
protected static void	validate(char[] chars, char[] alphabet)

Methods inherited from class java.lang.Object

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

Field Detail

ALPHABET_BASE_32

public static final String ALPHABET_BASE_32

See Also:

Constant Field Values

ALPHABET_BASE_32_HEX

public static final String ALPHABET_BASE_32_HEX

See Also:

Constant Field Values

ALPHABET_BASE_32_Z

public static final String ALPHABET_BASE_32_Z

See Also:

Constant Field Values

ALPHABET_BASE_32_CROCKFORD

public static final String ALPHABET_BASE_32_CROCKFORD

See Also:

Constant Field Values

Method Detail

toBase32

public static String toBase32(long number)

toBase32

public static String toBase32(BigInteger number)

toBase32

public static String toBase32(byte[] bytes)

toBase32

public static String toBase32(String string)

fromBase32

public static byte[] fromBase32(String string)

fromBase32AsString

public static String fromBase32AsString(String string)

fromBase32AsLong

public static long fromBase32AsLong(String string)

fromBase32AsBigInteger

public static BigInteger fromBase32AsBigInteger(String string)

toBase32Hex

public static String toBase32Hex(long number)

toBase32Hex

public static String toBase32Hex(BigInteger number)

toBase32Hex

public static String toBase32Hex(byte[] bytes)

toBase32Hex

public static String toBase32Hex(String string)

fromBase32Hex

public static byte[] fromBase32Hex(String string)

fromBase32HexAsString

public static String fromBase32HexAsString(String string)

fromBase32HexAsLong

public static long fromBase32HexAsLong(String string)

fromBase32HexAsBigInteger

public static BigInteger fromBase32HexAsBigInteger(String string)

toBase32Crockford

public static String toBase32Crockford(long number)

toBase32Crockford

public static String toBase32Crockford(BigInteger number)

toBase32Crockford

public static String toBase32Crockford(byte[] bytes)

toBase32Crockford

public static String toBase32Crockford(String string)

fromBase32Crockford

public static byte[] fromBase32Crockford(String string)

fromBase32CrockfordAsString

public static String fromBase32CrockfordAsString(String string)

fromBase32CrockfordAsLong

public static long fromBase32CrockfordAsLong(String string)

fromBase32CrockfordAsBigInteger

public static BigInteger fromBase32CrockfordAsBigInteger(String string)

toBase32Z

public static String toBase32Z(long number)

toBase32Z

public static String toBase32Z(BigInteger number)

toBase32Z

public static String toBase32Z(byte[] bytes)

toBase32Z

public static String toBase32Z(String string)

fromBase32Z

public static byte[] fromBase32Z(String string)

fromBase32ZAsString

public static String fromBase32ZAsString(String string)

fromBase32ZAsLong

public static long fromBase32ZAsLong(String string)

fromBase32ZAsBigInteger

public static BigInteger fromBase32ZAsBigInteger(String string)

toBytes

public static byte[] toBytes(String string)

Convert a string to an array of bytes using UTF-8.

Parameters:

string - a string

Returns:

a string

toString

public static String toString(byte[] bytes)

Convert an array of bytes to a string using UTF-8.

Parameters:

bytes - a byte sequence

Returns:

a string

encodeLong

public static String encodeLong(long number,
                                char[] alphabet)

Encode a long number to base 32 string.

Parameters:

number - a long number

alphabet - an alphabet

Returns:

a base32 encoded string

encodeBigInteger

public static String encodeBigInteger(BigInteger number,
                                      char[] alphabet)

Encode a BigInteger to base 32 string.

Parameters:

number - a BigInteger

alphabet - an alphabet

Returns:

a base32 encoded string

decodeLong

public static long decodeLong(String string,
                              char[] alphabet)

Decode a base 32 string to a long number.

Parameters:

string - a base 32 encoded string

alphabet - an alphabet

Returns:

a long number

decodeBigInteger

public static BigInteger decodeBigInteger(String string,
                                          char[] alphabet)

Decode a base 32 string to a BigInteger.

Parameters:

string - a base 32 encoded string

alphabet - an alphabet

Returns:

a BigInteger

encode

public static String encode(byte[] bytes,
                            char[] alphabet,
                            Character padding)

Encode an array of bytes into a base 32 string.

Parameters:

bytes - an array of bytes

alphabet - an alphabet

padding - a padding char, if necessary

Returns:

a base 32 encoded string

decode

public static byte[] decode(String string,
                            char[] alphabet,
                            Character padding)

Decode a base 32 string into an byte array.

Parameters:

string - a base 32 encoded string

alphabet - an alphabet

padding - a padding char, if necessary

Returns:

a byte array

validate

protected static void validate(char[] chars,
                               char[] alphabet)

normalize

protected static String normalize(String string)

normalizeZ

protected static String normalizeZ(String string)

normalizeCrockford

protected static String normalizeCrockford(String string)