de.slothsoft.random.types

Class CollectionRandomField

java.lang.Object

de.slothsoft.random.types.CollectionRandomField

All Implemented Interfaces:

RandomField

public class CollectionRandomField
extends Object
implements RandomField

A RandomField representing an Collection.

Since:

2.1.0

Author:

Stef Schulz

Field Summary

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
CollectionRandomField(Supplier<Collection<?>> collectionConstructor, RandomField elementRandomField) Constructor.

Method Summary

Modifier and Type	Method and Description
CollectionRandomField	collectionSize(int newCollectionSize) Sets the standard collection size.
int	getCollectionSize() Returns the standard collection size.
double	getNullProbability() Returns the probability for this field returning null.
Object	nextValue() Returns a random value.
CollectionRandomField	nullProbability(double newNullProbability) Sets the probability for this field returning null.
void	setCollectionSize(int collectionSize) Sets the standard collection size.
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

CollectionRandomField

public CollectionRandomField(Supplier<Collection<?>> collectionConstructor,
                             RandomField elementRandomField)

Constructor.

Parameters:

collectionConstructor - constructor to create the collection

elementRandomField - a generator for the elements

Method Detail

nextValue

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

nullProbability

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

getCollectionSize

public int getCollectionSize()

Returns the standard collection size. A Gaussian function is used to scatter the actual collection size around this value.

Returns:

collection size

collectionSize

public CollectionRandomField collectionSize(int newCollectionSize)

Sets the standard collection size. A Gaussian function is used to scatter the actual collection size around this value.

Parameters:

newCollectionSize - collection size

Returns:

this instance

setCollectionSize

public void setCollectionSize(int collectionSize)

Sets the standard collection size. A Gaussian function is used to scatter the actual collection size around this value.

Parameters:

collectionSize - collection size