de.slothsoft.random.types

Class CalendarRandomField

java.lang.Object

de.slothsoft.random.types.CalendarRandomField

All Implemented Interfaces:

RandomField

public class CalendarRandomField
extends Object

A RandomField representing a Calendar between 10 years ago and 10 years in the future.

Since:

2.1.0

Author:

Stef Schulz

Field Summary

Fields inherited from interface de.slothsoft.random.RandomField

RND

Constructor Summary

Constructors

Constructor and Description
CalendarRandomField()

Method Summary

Modifier and Type	Method and Description
CalendarRandomField	endValue(Calendar newEndValue) Sets the highest possible value for this field.
C	getEndValue() Returns the highest possible value for this field.
double	getNullProbability() Returns the probability for this field returning null.
C	getStartValue() Returns the lowest possible value for this field.
C	nextValue() Returns a random value.
de.slothsoft.random.types.AbstractChronoRandomField<C>	nullProbability(double newNullProbability) Sets the probability for this field returning null.
void	setEndValue(C endValue) Sets the highest possible value for this field.
void	setNullProbability(double nullProbability) Sets the probability for this field returning null.
void	setStartValue(C startValue) Sets the lowest possible value for this field.
CalendarRandomField	startValue(Calendar newStartValue) Sets the lowest possible value for this field.

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

CalendarRandomField

public CalendarRandomField()

Method Detail

endValue

public CalendarRandomField endValue(Calendar newEndValue)

Sets the highest possible value for this field.

Parameters:

newEndValue - end value

Returns:

this instance

startValue

public CalendarRandomField startValue(Calendar newStartValue)

Sets the lowest possible value for this field.

Parameters:

newStartValue - start value

Returns:

this instance

nextValue

public C nextValue()

Description copied from interface: RandomField

Returns a random value.

Specified by:

nextValue in interface RandomField

Returns:

a random value

getEndValue

public C getEndValue()

Returns the highest possible value for this field.

Returns:

end value

setEndValue

public void setEndValue(C endValue)

Sets the highest possible value for this field.

Parameters:

endValue - end value

getStartValue

public C getStartValue()

Returns the lowest possible value for this field.

Returns:

start value

setStartValue

public void setStartValue(C startValue)

Sets the lowest possible value for this field.

Parameters:

startValue - start 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 de.slothsoft.random.types.AbstractChronoRandomField<C> 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