de.slothsoft.random.types

Class BooleanRandomField

java.lang.Object

de.slothsoft.random.types.BooleanRandomField

All Implemented Interfaces:

RandomField

public class BooleanRandomField
extends Object
implements RandomField

A RandomField representing a Boolean or it's primitive counterpart.

Since:

1.0.0

Author:

Stef Schulz

Field Summary

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
BooleanRandomField()

Method Summary

Modifier and Type	Method and Description
double	getNullProbability() Returns the probability for this field returning null.
double	getTrueProbability() Returns the probability for this field returning true.
Boolean	nextValue() Returns a random value.
BooleanRandomField	nullProbability(double newNullProbability) Sets the probability for this field returning null.
void	setNullProbability(double nullProbability) Sets the probability for this field returning null.
void	setTrueProbability(double trueProbability) Sets the probability for this field returning true.
BooleanRandomField	trueProbability(double newTrueProbability) Sets the probability for this field returning true.

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

BooleanRandomField

public BooleanRandomField()

Method Detail

nextValue

public Boolean 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 BooleanRandomField 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

getTrueProbability

public double getTrueProbability()

Returns the probability for this field returning true. If the value is 0 then no nextValue() is true, if it is 1 then every nextValue() is true.

Returns:

the probability between 0 and 1

Since:

2.1.0

trueProbability

public BooleanRandomField trueProbability(double newTrueProbability)

Sets the probability for this field returning true. If the value is 0 then no nextValue() is true, if it is 1 then every nextValue() is true.

Parameters:

newTrueProbability - the probability between 0 and 1

Returns:

this instance

Since:

2.1.0

setTrueProbability

public void setTrueProbability(double trueProbability)

Sets the probability for this field returning true. If the value is 0 then no nextValue() is true, if it is 1 then every nextValue() is true.

Parameters:

trueProbability - the probability between 0 and 1

Since:

2.1.0