net.joala.data.random

Class AbstractRandomNumberProvider<T extends Comparable<? extends Number>>

java.lang.Object

net.joala.data.random.AbstractRandomDataProvider<T>

net.joala.data.random.AbstractRandomNumberProvider<T>

Type Parameters:

T - the number type you can retrieve from this data provider

All Implemented Interfaces:

DataProvider<T>, RandomDataProvider<T>, RandomNumberProvider<T>

Direct Known Subclasses:

RandomDoubleProvider, RandomFloatProvider, RandomIntegerProvider, RandomLongProvider

public abstract class AbstractRandomNumberProvider<T extends Comparable<? extends Number>>
extends AbstractRandomDataProvider<T>
implements RandomNumberProvider<T>

Abstract data provider for numbers. Numbers are expected to be comparable.

Since:

9/17/12

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRandomNumberProvider(RandomNumberType<T> numberType) Creates a random number provider bound to a specific type of numbers.

Method Summary

Methods

Modifier and Type	Method and Description
T	get() Retrieve a random data.
RandomNumberType<T>	getNumberType() Return the number type used for random number generation.
RandomNumberProvider<T>	max(T maxValue) Specifies the maximum value to retrieve via random.
RandomNumberProvider<T>	min(T minValue) Specifies the minimum value to retrieve via random.
String	toString()

Methods inherited from class net.joala.data.random.AbstractRandomDataProvider

fixate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.joala.data.random.RandomDataProvider

fixate

Constructor Detail

AbstractRandomNumberProvider

protected AbstractRandomNumberProvider(@Nonnull
                            RandomNumberType<T> numberType)

Creates a random number provider bound to a specific type of numbers.

Parameters:

numberType - denotes the type of random numbers to provide

Method Detail

min

public RandomNumberProvider<T> min(@Nullable
                          T minValue)

Description copied from interface: RandomNumberProvider

Specifies the minimum value to retrieve via random.

Specified by:

min in interface RandomNumberProvider<T extends Comparable<? extends Number>>

Parameters:

minValue - the minimum value; null will cause to reset to minimum value of number type

Returns:

self-reference

max

public RandomNumberProvider<T> max(@Nullable
                          T maxValue)

Description copied from interface: RandomNumberProvider

Specifies the maximum value to retrieve via random.

Specified by:

max in interface RandomNumberProvider<T extends Comparable<? extends Number>>

Parameters:

maxValue - the maximum value; null will cause to reset to maximum value of number type

Returns:

self-reference

get

public T get()
                                           throws DataProvidingException

Description copied from interface: DataProvider

Retrieve a random data.

Specified by:

get in interface DataProvider<T extends Comparable<? extends Number>>

Returns:

random data

Throws:

DataProvidingException - if an error occurred during data generation

getNumberType

@Nonnull
public final RandomNumberType<T> getNumberType()

Return the number type used for random number generation.

Returns:

random number type

toString

public String toString()

Overrides:

toString in class Object