com.github.f4b6a3.uuid.codec.base

Class BaseNCodec

java.lang.Object

com.github.f4b6a3.uuid.codec.base.BaseNCodec

All Implemented Interfaces:

UuidCodec<String>

Direct Known Subclasses:

Base16Codec, Base32Codec, Base58BtcCodec, Base62Codec, Base64Codec, Base64UrlCodec

public abstract class BaseNCodec
extends Object
implements UuidCodec<String>

Abstract class that contains the basic functionality for base-n codecs of this package.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseNCodec.CustomDivider A division function that returns quotient and remainder.

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseN	base The base-n.
protected Function<String,UUID>	decoder A decoder function.
protected Function<UUID,String>	encoder An encoder function.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseNCodec(BaseN base)
protected	BaseNCodec(BaseN base, BaseNCodec.CustomDivider divider)
protected	BaseNCodec(BaseN base, BaseNEncoder encoder, BaseNDecoder decoder)

Method Summary

Modifier and Type	Method and Description
UUID	decode(String string) Get a UUID from an encoded string.
String	encode(UUID uuid) Get an encoded string from a UUID.
BaseN	getBase() Get the base-n encoding object.
static BaseNCodec	newInstance(BaseN base) Static factory that returns a new instance of BaseNCodec using the specified BaseN.
static BaseNCodec	newInstance(BaseN base, BaseNCodec.CustomDivider divider) Static factory that returns a new instance of BaseNCodec using the specified BaseN and a BaseNCodec.CustomDivider.
static BaseNCodec	newInstance(int radix) Static factory that returns a new instance of BaseNCodec using the specified radix.
static BaseNCodec	newInstance(int radix, BaseNCodec.CustomDivider divider) Static factory that returns a new instance of BaseNCodec using the specified radix and a BaseNCodec.CustomDivider.
static BaseNCodec	newInstance(String alphabet) Static factory that returns a new instance of BaseNCodec using the specified alphabet.
static BaseNCodec	newInstance(String alphabet, BaseNCodec.CustomDivider divider) Static factory that returns a new instance of BaseNCodec using the specified alphabet and a BaseNCodec.CustomDivider.
protected void	validate(String string)

Methods inherited from class java.lang.Object

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

Field Detail

base

protected final BaseN base

The base-n.

encoder

protected final Function<UUID,String> encoder

An encoder function.

decoder

protected final Function<String,UUID> decoder

A decoder function.

Constructor Detail

BaseNCodec

protected BaseNCodec(BaseN base)

Parameters:

base - an object that represents the base-n encoding

BaseNCodec

protected BaseNCodec(BaseN base,
                     BaseNCodec.CustomDivider divider)

Parameters:

base - an object that represents the base-n encoding

divider - a division function that returns quotient and remainder

BaseNCodec

protected BaseNCodec(BaseN base,
                     BaseNEncoder encoder,
                     BaseNDecoder decoder)

Parameters:

base - an object that represents the base-n encoding

encoder - a functional encoder

decoder - a functional decoder

Method Detail

newInstance

public static BaseNCodec newInstance(BaseN base)

Static factory that returns a new instance of BaseNCodec using the specified BaseN.

This method can be used if none of the existing concrete codecs of this package class is desired.

The BaseNCodec objects provided by this method encode UUIDs using remainder operation (modulus), a common approach to encode integers.

If you need a BaseN that is not available in this package, use the static factories newInstance(String) or newInstance(int).

Parameters:

base - an object that represents the base-n encoding

Returns:

a BaseNCodec

newInstance

public static BaseNCodec newInstance(int radix)

Static factory that returns a new instance of BaseNCodec using the specified radix.

This method can be used if none of the existing concrete codecs of this package class is desired.

The BaseNCodec objects provided by this method encode UUIDs using remainder operator (modulus), a common approach to encode integers.

The example below shows how to create a BaseNCodec for an hypothetical base-40 encoding that contains only letters. You only need to pass a number 40. The BaseNCodec instantiates a BaseN object internally. See BaseN.

 String radix = 40;
 BaseNCodec codec = BaseNCodec.newInstance(radix);
 

If radix is greater than 36, the alphabet generated is a subset of the character sequence "0-9A-Za-z-_". Otherwise it is a subset of "0-9a-z". In the example above the resulting alphabet is "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcd" (0-9A-Za-d).

Parameters:

radix - the radix to be used

Returns:

a BaseNCodec

newInstance

public static BaseNCodec newInstance(String alphabet)

Static factory that returns a new instance of BaseNCodec using the specified alphabet.

This method can be used if none of the existing concrete codecs of this package class is desired.

The BaseNCodec objects provided by this method encode UUIDs using remainder operator (modulus), a common approach to encode integers.

The example below shows how to create a BaseNCodec for an hypothetical base-26 encoding that contains only letters. You only need to pass a string with 26 characters. The BaseNCodec instantiates a BaseN object internally. See BaseN.

 String alphabet = "abcdefghijklmnopqrstuvwxyz";
 BaseNCodec codec = BaseNCodec.newInstance(alphabet);
 

Alphabet strings similar to "a-f0-9" are expanded to "abcdef0123456789". The same example using the string "a-z" instead of "abcdefghijklmnopqrstuvwxyz":

 String alphabet = "a-z";
 BaseNCodec codec = BaseNCodec.newInstance(alphabet);
 

Parameters:

alphabet - the alphabet to be used

Returns:

a BaseNCodec

newInstance

public static BaseNCodec newInstance(BaseN base,
                                     BaseNCodec.CustomDivider divider)

Static factory that returns a new instance of BaseNCodec using the specified BaseN and a BaseNCodec.CustomDivider.

Parameters:

base - an object that represents the base-n encoding

divider - a division function that returns quotient and remainder

Returns:

a BaseNCodec

newInstance

public static BaseNCodec newInstance(int radix,
                                     BaseNCodec.CustomDivider divider)

Static factory that returns a new instance of BaseNCodec using the specified radix and a BaseNCodec.CustomDivider.

Parameters:

radix - the radix to be used

divider - a division function that returns quotient and remainder

Returns:

a BaseNCodec

newInstance

public static BaseNCodec newInstance(String alphabet,
                                     BaseNCodec.CustomDivider divider)

Static factory that returns a new instance of BaseNCodec using the specified alphabet and a BaseNCodec.CustomDivider.

Parameters:

alphabet - the alphabet to be used

divider - a division function that returns quotient and remainder

Returns:

a BaseNCodec

getBase

public BaseN getBase()

Get the base-n encoding object.

Returns:

a base-n encoding object

encode

public String encode(UUID uuid)

Get an encoded string from a UUID.

Specified by:

encode in interface UuidCodec<String>

Parameters:

uuid - a UUID

Returns:

an encoded string

Throws:

InvalidUuidException - if the argument is invalid

decode

public UUID decode(String string)

Get a UUID from an encoded string.

Specified by:

decode in interface UuidCodec<String>

Parameters:

string - the encoded string

Returns:

a UUID

Throws:

InvalidUuidException - if the argument is invalid

validate

protected void validate(String string)