Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util

Class Base32

java.lang.Object

org.tquadrat.foundation.util.Base32

@ClassVersion(sourceVersion="$Id: Base32.java 1060 2023-09-24 19:21:40Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
@UtilityClass
public final class Base32
extends Object

This class provides an Encoder and a Decoder for Crockfords's Base 32 format.

Base 32 allows to represent large numbers as strings with less characters than Base 10 (the regular decimal system) or Base 16 (the hexadecimal system). It has the advantage over Base 64 that it uses less symbols, and no special characters.

While Base is mainly for (large) numbers, it can be used for strings, to, in the same way as Base 64. But different from that, Base 32 is not really standardized; this version, introduced by Douglas Crockford, is just one among various others.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Thanks to:

Douglas Crockford (douglas@crockford.com)

Version:

$Id: Base32.java 1060 2023-09-24 19:21:40Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.Base32"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Base32.Decoder	The Decoder for Crockfords's Base 32 format.
static final class	Base32.Encoder	The Encoder for Crockfords's Base 32 format.

Field Summary

Fields

Modifier and Type	Field	Description
private static final char[]	ALPHABET_LOWERCASE	The lowercase symbols for the Base 32 alphabet.
private static final char[]	ALPHABET_UPPERCASE	The uppercase symbols for the Base 32 alphabet.
private static final long[]	ALPHABET_VALUES	The symbol values.
static final byte[]	EMPTY_byte_ARRAY	An empty byte array.
private static final Base32.Decoder	m_Decoder	The Base 32 decoder instance.
private static final Base32.Encoder	m_Encoder	The Base 32 encoder instance.
private static final int	RADIX	The radix for Base 32 is, as one would expect: 32.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Base32()	No instance allowed for this class.

Method Summary

Modifier and Type	Method	Description
static final Base32.Decoder	getDecoder()	Returns a decoder for Crockfords's Base 32 format.
static final Base32.Encoder	getEncoder()	Returns an encoder for Crockfords's Base 32 format.

Methods inherited from class java.lang.Object

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

Field Details

ALPHABET_LOWERCASE

private static final char[] ALPHABET_LOWERCASE

The lowercase symbols for the Base 32 alphabet.

ALPHABET_UPPERCASE

private static final char[] ALPHABET_UPPERCASE

The uppercase symbols for the Base 32 alphabet.

EMPTY_byte_ARRAY

public static final byte[] EMPTY_byte_ARRAY

An empty byte array.

RADIX

private static final int RADIX

The radix for Base 32 is, as one would expect: 32.

See Also:

• Constant Field Values

ALPHABET_VALUES

private static final long[] ALPHABET_VALUES

The symbol values.

m_Decoder

private static final Base32.Decoder m_Decoder

The Base 32 decoder instance.

m_Encoder

private static final Base32.Encoder m_Encoder

The Base 32 encoder instance.

Constructor Details

Base32

private Base32()

No instance allowed for this class.

Method Details

getDecoder

public static final Base32.Decoder getDecoder()

Returns a decoder for Crockfords's Base 32 format.

Returns:

The decoder.

getEncoder

public static final Base32.Encoder getEncoder()

Returns an encoder for Crockfords's Base 32 format.

Returns:

The encoder.