de.slothsoft.random.types

Class AbstractNumberRandomField<N extends Number>

java.lang.Object

de.slothsoft.random.types.AbstractNumberRandomField<N>

Type Parameters:

N - a type of number

All Implemented Interfaces:

RandomField

Direct Known Subclasses:

BigDecimalRandomField, BigIntegerRandomField, DoubleRandomField, FloatRandomField, IntegerRandomField, LongRandomField, ShortRandomField

public abstract class AbstractNumberRandomField<N extends Number>
extends Object
implements RandomField

A base class for creating a RandomField from a Number.

Since:

1.0.0

Author:

Stef Schulz

Field Summary

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
AbstractNumberRandomField()

Method Summary

Modifier and Type	Method and Description
AbstractNumberRandomField<N>	endValue(N newEndValue) Sets the end value, i.e.
N	getEndValue() Returns the end value, i.e.
double	getNullProbability() Returns the probability for this field returning null.
N	getStartValue() Returns the start value, i.e.
N	nextValue() Returns a random value.
AbstractNumberRandomField<N>	nullProbability(double newNullProbability) Sets the probability for this field returning null.
void	setEndValue(N endValue) Sets the end value, i.e.
void	setNullProbability(double nullProbability) Sets the probability for this field returning null.
void	setStartValue(N startValue) Sets the start value, i.e.
AbstractNumberRandomField<N>	startValue(N newStartValue) Sets the start value, i.e.

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

AbstractNumberRandomField

public AbstractNumberRandomField()

Method Detail

nextValue

public N nextValue()

Description copied from interface: RandomField

Returns a random value.

Specified by:

nextValue in interface RandomField

Returns:

a random value

getStartValue

public N getStartValue()

Returns the start value, i.e. nextValue() will always be greater than this value.

Returns:

the start value

startValue

public AbstractNumberRandomField<N> startValue(N newStartValue)

Sets the start value, i.e. nextValue() will always be greater than this value.

Parameters:

newStartValue - the start value

Returns:

this instance

setStartValue

public void setStartValue(N startValue)

Sets the start value, i.e. nextValue() will always be greater than this value.

Parameters:

startValue - the start value

getEndValue

public N getEndValue()

Returns the end value, i.e. nextValue() will always be less than this value.

Returns:

the end value

endValue

public AbstractNumberRandomField<N> endValue(N newEndValue)

Sets the end value, i.e. nextValue() will always be less than this value.

Parameters:

newEndValue - the end value

Returns:

this instance

setEndValue

public void setEndValue(N endValue)

Sets the end value, i.e. nextValue() will always be less than this value.

Parameters:

endValue - the end 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 AbstractNumberRandomField<N> 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