com.arcticicestudio.icecore.hashids

Class Hashids.Builder

java.lang.Object

com.arcticicestudio.icecore.hashids.Hashids.Builder

Enclosing class:

Hashids

public static final class Hashids.Builder
extends Object

An immutable Hashids instance builder with optional features.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs a new instance without a salt, no minimum hash length, the default alphabet and no enabled features.

Method Summary

Modifier and Type	Method and Description
Hashids.Builder	alphabet(String alphabet) Sets the alphabet to be used for the hash generation.
Hashids	build() Builds a new configured Hashids instance.
Hashids.Builder	features(HashidsFeature... features) Enables the given instance features.
Hashids.Builder	minLength(int minLength) Sets the minimum hash length.
Hashids.Builder	salt(String salt) Sets the salt to be used as entropy.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs a new instance without a salt, no minimum hash length, the default alphabet and no enabled features.

Method Detail

salt

public Hashids.Builder salt(String salt)

Sets the salt to be used as entropy.

By default the salt is empty.

Parameters:

salt - the salt to be used as entropy

Returns:

a new builder instance with the given salt

minLength

public Hashids.Builder minLength(int minLength)

Sets the minimum hash length.

The default value is 0.

Parameters:

minLength - the minimum hash length

Returns:

a new builder instance with the given minimum hash length

alphabet

public Hashids.Builder alphabet(String alphabet)

Sets the alphabet to be used for the hash generation.

The default value is the default alphabet.

Parameters:

alphabet - the alphabet to be used for the hash generation

Returns:

a new builder instance with the given alphabet

features

public Hashids.Builder features(HashidsFeature... features)

Enables the given instance features.

By default no features are enabled.

Parameters:

features - the features to be enabled for this instance

Returns:

a new builder instance with the enabled features

Since:

0.4.0

build

public Hashids build()

Builds a new configured Hashids instance.

Returns:

a new configured instance