com.comphenix.xp.extra

Class ConstantRandom

java.lang.Object

java.util.Random

com.comphenix.xp.extra.ConstantRandom

All Implemented Interfaces:

java.io.Serializable

public class ConstantRandom
extends java.util.Random

Represents a random number provider that uses a byte array a source of random numbers.

Author:

Kristian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ConstantRandom	MAXIMUM A random number generator that always returns the largest possible value.
static ConstantRandom	MINIMUM A random number generator that always returns the lowest possible value.

Constructor Summary

Constructors

Constructor and Description
ConstantRandom(byte wrapValue) Constructs a random generator that uses an infinite stream of bytes as the source of "randomness".
ConstantRandom(byte[] data) Constructs a random generator from a given byte source, starting at the given bit offset.
ConstantRandom(byte[] data, boolean wrapAround) Constructs a random generator from a given byte source, starting at the given bit offset.
ConstantRandom(byte[] data, boolean wrapAround, int offset) Constructs a random generator from a given byte source, starting at the given bit offset.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getData() Retrieves the bit array we're using as a source for our random numbers.
int	getIndex() Retrieves the bit index in the byte array we're reading from.
boolean	isWrapAround() Whether or not we wrap around after reaching the end of the byte array.
protected int	next(int bits)
int	nextInt(int n)
void	setData(byte[] data) Sets the bit array, represented as a byte array, we'll use as a source for our random numbers.
void	setIndex(int index) Sets the bit index in the byte array we're reading from.
void	setWrapAround(boolean wrapAround) Whether or not we wrap around after reaching the end of the byte array.

Methods inherited from class java.util.Random

nextBoolean, nextBytes, nextDouble, nextFloat, nextGaussian, nextInt, nextLong, setSeed

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM

public static ConstantRandom MAXIMUM

A random number generator that always returns the largest possible value.

MINIMUM

public static ConstantRandom MINIMUM

A random number generator that always returns the lowest possible value.

Constructor Detail

ConstantRandom

public ConstantRandom(byte[] data)

Constructs a random generator from a given byte source, starting at the given bit offset.

Parameters:

data - - source of bytes to use in the random number generator.

ConstantRandom

public ConstantRandom(byte wrapValue)

Constructs a random generator that uses an infinite stream of bytes as the source of "randomness".

Parameters:

wrapValue - - the value that will be copied infinitely in the stream.

ConstantRandom

public ConstantRandom(byte[] data,
              boolean wrapAround)

Constructs a random generator from a given byte source, starting at the given bit offset.

Parameters:

data - - source of bytes to use in the random number generator.

wrapAround - - TRUE to wrap around when the reader has reached the last byte element, FALSE to raise an exception.

ConstantRandom

public ConstantRandom(byte[] data,
              boolean wrapAround,
              int offset)

Constructs a random generator from a given byte source, starting at the given bit offset.

Parameters:

data - - source of bytes to use in the random number generator.

wrapAround - - TRUE to wrap around when the reader has reached the last byte element, FALSE to raise an exception.

offset - - the bit to start reading from.

Method Detail

nextInt

public int nextInt(int n)

Overrides:

nextInt in class java.util.Random

next

protected int next(int bits)

Overrides:

next in class java.util.Random

getData

public byte[] getData()

Retrieves the bit array we're using as a source for our random numbers.

Returns:

The bit array, represented with a byte array.

setData

public void setData(byte[] data)

Sets the bit array, represented as a byte array, we'll use as a source for our random numbers.

Parameters:

data - - new byte array to use.

getIndex

public int getIndex()

Retrieves the bit index in the byte array we're reading from.

Returns:

The current bit index.

setIndex

public void setIndex(int index)

Sets the bit index in the byte array we're reading from.

Parameters:

index - - new bit index in the array.

setWrapAround

public void setWrapAround(boolean wrapAround)

Whether or not we wrap around after reaching the end of the byte array.

Parameters:

wrapAround - - TRUE to wrap around, FALSE to raise an exception.

isWrapAround

public boolean isWrapAround()

Whether or not we wrap around after reaching the end of the byte array.

Returns:

TRUE if we wrap around, FALSE otherwise.