de.slothsoft.random.types

Class ArrayRandomField

java.lang.Object

de.slothsoft.random.types.ArrayRandomField

All Implemented Interfaces:

RandomField

public class ArrayRandomField
extends Object
implements RandomField

A RandomField representing an array.

Since:

2.1.0

Author:

Stef Schulz

Field Summary

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
ArrayRandomField(Class<?> elementClass, RandomField elementRandomField) Constructor.

Method Summary

Modifier and Type	Method and Description
ArrayRandomField	arrayLength(int newArrayLength) Sets the standard array length.
int	getArrayLength() Returns the standard array length.
double	getNullProbability() Returns the probability for this field returning null.
Object	nextValue() Returns a random value.
ArrayRandomField	nullProbability(double newNullProbability) Sets the probability for this field returning null.
void	setArrayLength(int arrayLength) Sets the standard array length.
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

ArrayRandomField

public ArrayRandomField(Class<?> elementClass,
                        RandomField elementRandomField)

Constructor.

Parameters:

elementClass - the element's class

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 ArrayRandomField 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

getArrayLength

public int getArrayLength()

Returns the standard array length. A Gaussian function is used to scatter the actual array length around this value.

Returns:

array length

arrayLength

public ArrayRandomField arrayLength(int newArrayLength)

Sets the standard array length. A Gaussian function is used to scatter the actual array length around this value.

Parameters:

newArrayLength - array length

Returns:

this instance

setArrayLength

public void setArrayLength(int arrayLength)

Sets the standard array length. A Gaussian function is used to scatter the actual array length around this value.

Parameters:

arrayLength - array length