Module org.refcodes.generator

Package org.refcodes.generator

Enum Class UniqueIdGenerator.IdEncoding

java.lang.Object

java.lang.Enum<UniqueIdGenerator.IdEncoding>

org.refcodes.generator.UniqueIdGenerator.IdEncoding

All Implemented Interfaces:

Serializable, Comparable<UniqueIdGenerator.IdEncoding>, Constable

Enclosing class:

UniqueIdGenerator

public static enum UniqueIdGenerator.IdEncoding
extends Enum<UniqueIdGenerator.IdEncoding>

Defines the type of BASE-64 encoding to use for generated IDs.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASE64	Normal BASE-64 alike encoding (padding chars are omitted).
BASE64_URL	BASE64 URL alike encoding (padding chars are omitted) enabling the use of the IDs in an URL.

Method Summary

Modifier and Type	Method	Description
static UniqueIdGenerator.IdEncoding	valueOf(String name)	Returns the enum constant of this class with the specified name.
static UniqueIdGenerator.IdEncoding[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BASE64

public static final UniqueIdGenerator.IdEncoding BASE64

Normal BASE-64 alike encoding (padding chars are omitted).

BASE64_URL

public static final UniqueIdGenerator.IdEncoding BASE64_URL

BASE64 URL alike encoding (padding chars are omitted) enabling the use of the IDs in an URL.

Method Details

values

public static UniqueIdGenerator.IdEncoding[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static UniqueIdGenerator.IdEncoding valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null