de.slothsoft.random.types

Class CharacterRandomField

java.lang.Object

de.slothsoft.random.types.CharacterRandomField

All Implemented Interfaces:

RandomField

public class CharacterRandomField
extends Object
implements RandomField

Generates letters after a defined config stored in WordGeneratorConfig.

Since:

2.1.0

Author:

Stef Schulz

Constructor Summary

Constructors

Constructor and Description
CharacterRandomField() Default constructor.

Method Summary

Modifier and Type	Method and Description
CharacterRandomField	capitalProbability(double newCapitalProbability) Sets the probability for this field returning capital.
CharacterRandomField	config(WordGeneratorConfig newConfig) Sets the used config.
double	getCapitalProbability() Returns the probability for this field returning capital.
WordGeneratorConfig	getConfig() Returns the used config.
double	getNullProbability() Returns the probability for this field returning null.
Character	nextValue() Generates a brand new word.
CharacterRandomField	nullProbability(double newNullProbability) Sets the probability for this field returning null.
void	setCapitalProbability(double capitalProbability) Sets the probability for this field returning capital.
void	setConfig(WordGeneratorConfig config) Sets the used config.
void	setNullProbability(double nullProbability) Sets the probability for this field returning null.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.slothsoft.random.RandomField

init

Constructor Detail

CharacterRandomField

public CharacterRandomField()

Default constructor.

Method Detail

nextValue

public Character nextValue()

Generates a brand new word.

Specified by:

nextValue in interface RandomField

Returns:

a word

getConfig

public WordGeneratorConfig getConfig()

Returns the used config.

Returns:

a config

config

public CharacterRandomField config(WordGeneratorConfig newConfig)

Sets the used config.

Parameters:

newConfig - a config

Returns:

this instance

setConfig

public void setConfig(WordGeneratorConfig config)

Sets the used config.

Parameters:

config - a config

getNullProbability

public double getNullProbability()

Returns the probability for this field returning null. If the value is 0 then no nextValue() is null, if it is 1 then every nextValue() is null.

Returns:

the probability between 0 and 1

nullProbability

public CharacterRandomField nullProbability(double newNullProbability)

Sets the probability for this field returning null. If the value is 0 then no nextValue() is null, if it is 1 then every nextValue() is null.

Parameters:

newNullProbability - the probability between 0 and 1

Returns:

this instance

setNullProbability

public void setNullProbability(double nullProbability)

Sets the probability for this field returning null. If the value is 0 then no nextValue() is null, if it is 1 then every nextValue() is null.

Parameters:

nullProbability - the probability between 0 and 1

getCapitalProbability

public double getCapitalProbability()

Returns the probability for this field returning capital. If the value is 0 then no nextValue() is a capital letter, if it is 1 then every nextValue() is a capital letter.

Returns:

the probability between 0 and 1

capitalProbability

public CharacterRandomField capitalProbability(double newCapitalProbability)

Sets the probability for this field returning capital. If the value is 0 then no nextValue() is a capital letter, if it is 1 then every nextValue() is a capital letter.

Parameters:

newCapitalProbability - the probability between 0 and 1

Returns:

this instance

setCapitalProbability

public void setCapitalProbability(double capitalProbability)

Sets the probability for this field returning capital. If the value is 0 then no nextValue() is a capital letter, if it is 1 then every nextValue() is a capital letter.

Parameters:

capitalProbability - the probability between 0 and 1