de.slothsoft.random.types

Class FirstNameRandomField

java.lang.Object

de.slothsoft.random.types.FirstNameRandomField

All Implemented Interfaces:

RandomField

public class FirstNameRandomField
extends Object
implements RandomField

A RandomField representing a String that should look like a first name.

Since:

1.0.0

Author:

Stef Schulz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirstNameRandomField.Gender Enum for setting the Gender of the first name.

Field Summary

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
FirstNameRandomField() Default constructor.

Method Summary

Modifier and Type	Method and Description
FirstNameRandomField	gender(FirstNameRandomField.Gender newGender) Sets the gender of the generated first names.
FirstNameRandomField.Gender	getGender() Returns the gender of the generated first names.
double	getNullProbability() Returns the probability for this field returning null.
String	nextValue() Returns a random value.
FirstNameRandomField	nullProbability(double newNullProbability) Sets the probability for this field returning null.
void	setGender(FirstNameRandomField.Gender gender) Sets the gender of the generated first names.
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

FirstNameRandomField

public FirstNameRandomField()

Default constructor.

Method Detail

nextValue

public String nextValue()

Description copied from interface: RandomField

Returns a random value.

Specified by:

nextValue in interface RandomField

Returns:

a random value

getGender

public FirstNameRandomField.Gender getGender()

Returns the gender of the generated first names.

Returns:

the gender; never null

gender

public FirstNameRandomField gender(FirstNameRandomField.Gender newGender)

Sets the gender of the generated first names.

Parameters:

newGender - the gender; cannot be null

Returns:

this instance

setGender

public void setGender(FirstNameRandomField.Gender gender)

Sets the gender of the generated first names.

Parameters:

gender - the gender; cannot be null

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

Since:

2.1.0

nullProbability

public FirstNameRandomField 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

Since:

2.1.0

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

Since:

2.1.0