com.arcticicestudio.icecore.hashids

Enum HashidsFeature

java.lang.Object

java.lang.Enum<HashidsFeature>

com.arcticicestudio.icecore.hashids.HashidsFeature

All Implemented Interfaces:

Serializable, Comparable<HashidsFeature>

public enum HashidsFeature
extends Enum<HashidsFeature>

Enumeration that defines optional features for the Hashids.Builder.

Please note that almost every feature will break the interoperability with the origin algorithm implementation if enabled!

Since:

0.4.0

Author:

Arctic Ice Studio <development@arcticicestudio.com>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALLOW_HEXADECIMAL_NUMBER_PREFIX Enables support for the 0x or 0X hexadecimal format prefixes of parameter values passed to the encodeHex(String)and decodeHex(String) methods.
EXCEPTION_HANDLING Enables the handling of exceptions instead of returning empty values when invalid parameters are passed to any public API method.
NO_MAX_INTEROP_NUMBER_SIZE Disables the maximum number size limit which ensures the interoperability with the origin algorithm implementation hashids.js and allows the usage of the Java Long maxiumum value.

Field Summary

Fields

Modifier and Type	Field and Description
static EnumSet<HashidsFeature>	ALL Enables all features.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALLOW_HEXADECIMAL_NUMBER_PREFIX

public static final HashidsFeature ALLOW_HEXADECIMAL_NUMBER_PREFIX

Enables support for the 0x or 0X hexadecimal format prefixes of parameter values passed to the encodeHex(String)and decodeHex(String) methods.

Please note that this will break the interoperability with the origin algorithm implementation!

See Also:

Hexadecimal - Written representation

EXCEPTION_HANDLING

public static final HashidsFeature EXCEPTION_HANDLING

Enables the handling of exceptions instead of returning empty values when invalid parameters are passed to any public API method.

Please note that this will break the interoperability with the origin algorithm implementation!

NO_MAX_INTEROP_NUMBER_SIZE

public static final HashidsFeature NO_MAX_INTEROP_NUMBER_SIZE

Disables the maximum number size limit which ensures the interoperability with the origin algorithm implementation hashids.js and allows the usage of the Java Long maxiumum value.

Please note that this will break the interoperability with the origin algorithm implementation!

Field Detail

ALL

public static final EnumSet<HashidsFeature> ALL

Enables all features.

Method Detail

values

public static HashidsFeature[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HashidsFeature c : HashidsFeature.values())
    System.out.println(c);

Returns:

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

valueOf

public static HashidsFeature valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null