org.symphonyoss.s2.fugue.di.component

Interface IRandomNumberProvider

All Superinterfaces:

IComponent

All Known Implementing Classes:

RandomNumberProvider

public interface IRandomNumberProvider
extends IComponent

A source of random data.

Author:

Bruce Skingle

Method Summary

Modifier and Type	Method and Description
boolean	nextBoolean() Returns a pseudorandom, uniformly distributed boolean value.
void	nextBytes(byte[] bytes) Generates random bytes and places them into a user-supplied byte array.
double	nextDouble() Returns a pseudorandom, uniformly distributed double value between 0.0 and 1.0.
float	nextFloat() Returns a pseudorandom, uniformly distributed float value between 0.0 and 1.0.
double	nextGaussian() Returns a pseudorandom, Gaussian ("normally") distributed double value with mean 0.0 and standard deviation 1.0.
int	nextInt() Returns a pseudorandom, uniformly distributed int value.
int	nextInt(int bound) Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive).
long	nextLong() Returns a pseudorandom, uniformly distributed long value.

Methods inherited from interface org.symphonyoss.s2.fugue.di.IComponent

getComponentDescriptor

Method Detail

nextInt

int nextInt()

Returns a pseudorandom, uniformly distributed int value. The general contract of nextInt is that one int value is pseudorandomly generated and returned. All 2³² possible int values are produced with (approximately) equal probability.

Returns:

a pseudorandom, uniformly distributed int value

nextInt

int nextInt(int bound)

Returns a pseudorandom, uniformly distributed int value between 0 (inclusive) and the specified value (exclusive).

Parameters:

bound - the upper bound (exclusive). Must be positive.

Returns:

a pseudorandom, uniformly distributed int value between zero (inclusive) and bound (exclusive)

Throws:

IllegalArgumentException - if bound is not positive

nextLong

long nextLong()

Returns a pseudorandom, uniformly distributed long value. The general contract of nextInt is that one long value is pseudorandomly generated and returned. All 2⁶⁴ possible long values are produced with (approximately) equal probability.

Returns:

a pseudorandom, uniformly distributed int value

nextBoolean

boolean nextBoolean()

Returns a pseudorandom, uniformly distributed boolean value.

Returns:

a pseudorandom, uniformly distributed boolean value

nextBytes

void nextBytes(@Nonnull
               byte[] bytes)

Generates random bytes and places them into a user-supplied byte array. The number of random bytes produced is equal to the length of the byte array.

Parameters:

bytes - the byte array to fill with random bytes

Throws:

NullPointerException - if the byte array is null

nextFloat

float nextFloat()

Returns a pseudorandom, uniformly distributed float value between 0.0 and 1.0.

Returns:

a pseudorandom, uniformly distributed float value between 0.0 and 1.0

nextDouble

double nextDouble()

Returns a pseudorandom, uniformly distributed double value between 0.0 and 1.0.

Returns:

a pseudorandom, uniformly distributed double value between 0.0 and 1.0

nextGaussian

double nextGaussian()

Returns a pseudorandom, Gaussian ("normally") distributed double value with mean 0.0 and standard deviation 1.0.

Returns:

a pseudorandom, Gaussian ("normally") distributed double value with mean 0.0 and standard deviation 1.0