net.joala.data.random

Interface RandomNumberType<T extends Comparable<? extends Number>>

All Known Implementing Classes:

AbstractRandomNumberType

public interface RandomNumberType<T extends Comparable<? extends Number>>

Describes random numbers to create. This interface is required by AbstractRandomNumberProvider in order to calculate a random number in the given range.

Since:

9/14/12

Method Summary

Methods

Modifier and Type	Method and Description
Class<T>	getType() Type of the number.
T	max() The maximum value supported for this number type.
T	min() The minimum value supported for this number type.
T	percentOf(double percent, T value) Return the percentage of the given value.
T	sum(T value1, T value2) Create the sum of the two values.

Method Detail

getType

@Nonnull
Class<T> getType()

Type of the number.

Returns:

the type of numbers to create

min

@Nonnull
T min()

The minimum value supported for this number type. Typically used as default minimum value.

Returns:

minimum number which might be created

max

@Nonnull
T max()

The maximum value supported for this number type. Typically used as default maximum value.

Returns:

maximum number which might be created

sum

@Nonnull
T sum(T value1,
            T value2)

Create the sum of the two values.

Parameters:

value1 - first value

value2 - second value

Returns:

sum

percentOf

@Nonnull
T percentOf(double percent,
                  T value)

Return the percentage of the given value. Typically used to locate a number in a given range on the provided numerical ray.

Parameters:

percent - percent ranging between 0 and 1

value - value to calculate the percentage of

Returns:

percentage of given value