de.slothsoft.random.types.wordgen

Enum StandardWordGeneratorConfig

java.lang.Object

java.lang.Enum<StandardWordGeneratorConfig>

de.slothsoft.random.types.wordgen.StandardWordGeneratorConfig

All Implemented Interfaces:

WordGeneratorConfig, Serializable, Comparable<StandardWordGeneratorConfig>

public enum StandardWordGeneratorConfig
extends Enum<StandardWordGeneratorConfig>
implements WordGeneratorConfig

Standard WordGeneratorConfigs.

Since:

2.1.0

Author:

Stef Schulz

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENGLISH A English distribution of letters.
EVEN_DISTRIBUTION An even distribution of letters.
GERMAN A German distribution of letters.

Method Summary

Modifier and Type	Method and Description
double	getProbability(char c) Returns the probability for a specific character that got returned via WordGeneratorConfig.getSupportedCharacters().
double	getStandardWordLength() Returns the standard word length.
char[]	getSupportedCharacters() Returns the supported lower case characters.
static StandardWordGeneratorConfig	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandardWordGeneratorConfig[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EVEN_DISTRIBUTION

public static final StandardWordGeneratorConfig EVEN_DISTRIBUTION

An even distribution of letters.

ENGLISH

public static final StandardWordGeneratorConfig ENGLISH

A English distribution of letters.

GERMAN

public static final StandardWordGeneratorConfig GERMAN

A German distribution of letters.

Method Detail

values

public static StandardWordGeneratorConfig[] 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 (StandardWordGeneratorConfig c : StandardWordGeneratorConfig.values())
    System.out.println(c);

Returns:

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

valueOf

public static StandardWordGeneratorConfig 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

getSupportedCharacters

public char[] getSupportedCharacters()

Description copied from interface: WordGeneratorConfig

Returns the supported lower case characters.

Specified by:

getSupportedCharacters in interface WordGeneratorConfig

Returns:

all lower case characters

getStandardWordLength

public double getStandardWordLength()

Description copied from interface: WordGeneratorConfig

Returns the standard word length.

Specified by:

getStandardWordLength in interface WordGeneratorConfig

Returns:

the word length

getProbability

public double getProbability(char c)

Description copied from interface: WordGeneratorConfig

Returns the probability for a specific character that got returned via WordGeneratorConfig.getSupportedCharacters().

Specified by:

getProbability in interface WordGeneratorConfig

Parameters:

c - a supported character

Returns:

it's probability