de.slothsoft.random.types

Class WordRandomField

java.lang.Object

de.slothsoft.random.types.WordRandomField

All Implemented Interfaces:

RandomField

public class WordRandomField
extends Object
implements RandomField

Generates a word after a defined config stored in WordGeneratorConfig.

Since:

2.1.0

Author:

Stef Schulz

Constructor Summary

Constructors

Constructor and Description
WordRandomField() Default constructor.

Method Summary

Modifier and Type	Method and Description
WordRandomField	config(WordGeneratorConfig newConfig) Sets the used config.
WordGeneratorConfig	getConfig() Returns the used config.
double	getNullProbability() Returns the probability for this field returning null.
String	nextValue() Generates a brand new word.
WordRandomField	nullProbability(double newNullProbability) Sets the probability for this field returning null.
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

WordRandomField

public WordRandomField()

Default constructor.

Method Detail

nextValue

public String 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 WordRandomField 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 WordRandomField 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