de.slothsoft.random.types

Class ElementFromListRandomField<E>

java.lang.Object

de.slothsoft.random.types.ElementFromListRandomField<E>

All Implemented Interfaces:

RandomField

Direct Known Subclasses:

CityRandomField, EnumRandomField, LastNameRandomField, StreetRandomField

public class ElementFromListRandomField<E>
extends Object
implements RandomField

A RandomField representing an arbitrary object that is filled with a random list element.

Since:

2.0.0

Author:

Stef Schulz

Field Summary

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
ElementFromListRandomField(E[] possibleElements) Some constructor.

Method Summary

Modifier and Type	Method and Description
double	getNullProbability() Returns the probability for this field returning null.
E	nextValue() Returns a random value.
ElementFromListRandomField<E>	nullProbability(double newNullProbability) Sets the probability for this field returning null.
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

ElementFromListRandomField

public ElementFromListRandomField(E[] possibleElements)

Some constructor.

Parameters:

possibleElements - the elements that are possible here; never null

Method Detail

nextValue

public E nextValue()

Description copied from interface: RandomField

Returns a random value.

Specified by:

nextValue in interface RandomField

Returns:

a random value

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 ElementFromListRandomField<E> 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