Package adams.data.random

Class JavaRandomInt

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.random.AbstractRandomNumberGenerator<T>

adams.data.random.AbstractSeededRandomNumberGenerator<Integer>

adams.data.random.JavaRandomInt

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Randomizable, ShallowCopySupporter<RandomNumberGenerator>, SizeOfHandler, RandomIntegerRangeGenerator<Integer>, RandomNumberGenerator<Integer>, SeededRandomNumberGenerator<Integer>, Serializable

public class JavaRandomInt
extends AbstractSeededRandomNumberGenerator<Integer>
implements RandomIntegerRangeGenerator<Integer>

Random generator that generates random integers using Java's java.util.Random class.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-seed <long> (property: seed)
    The seed value for the random number generator.
    default: 1
 

-min-value <int> (property: minValue)
    The smallest number that could be generated.
    default: 1
 

-max-value <int> (property: maxValue)
    The largest number that could be generated.
    default: 1000
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Random.nextInt(int), Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_MaxValue	the maximum value for the numbers to generate.
protected int	m_MinValue	the minimum value for the numbers to generate.
protected Random	m_Random	the random number generator to use.

Fields inherited from class adams.data.random.AbstractSeededRandomNumberGenerator

m_Seed

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
JavaRandomInt()

Method Summary

Modifier and Type	Method	Description
protected void	check()	Performs optional checks.
void	defineOptions()	Adds options to the internal list of options.
protected Integer	doNext()	Returns the next random number.
int	getMaxValue()	Returns the maximum value of the numbers to generate.
int	getMinValue()	Returns the minimum value of the numbers to generate.
String	globalInfo()	Returns a string describing the object.
String	maxValueTipText()	Returns the tip text for this property.
String	minValueTipText()	Returns the tip text for this property.
void	reset()	Resets the generator.
void	setMaxValue(int value)	Sets the maximum value of the numbers to generate.
void	setMinValue(int value)	Sets the minimum value of the numbers to generate.

Methods inherited from class adams.data.random.AbstractSeededRandomNumberGenerator

getSeed, seedTipText, setSeed

Methods inherited from class adams.data.random.AbstractRandomNumberGenerator

forCommandLine, forName, getGenerators, next, shallowCopy, shallowCopy

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.data.random.RandomNumberGenerator

next

Methods inherited from interface adams.core.ShallowCopySupporter

shallowCopy, shallowCopy

Field Detail

m_MinValue

protected int m_MinValue

the minimum value for the numbers to generate.

m_MaxValue

protected int m_MaxValue

the maximum value for the numbers to generate.

m_Random

protected Random m_Random

the random number generator to use.

Constructor Detail

JavaRandomInt

public JavaRandomInt()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractSeededRandomNumberGenerator<Integer>

reset

public void reset()

Resets the generator.

Specified by:

reset in interface RandomNumberGenerator<Integer>

Overrides:

reset in class AbstractRandomNumberGenerator<Integer>

setMinValue

public void setMinValue(int value)

Sets the minimum value of the numbers to generate.

Specified by:

setMinValue in interface RandomIntegerRangeGenerator<Integer>

Parameters:

value - the minimum

getMinValue

public int getMinValue()

Returns the minimum value of the numbers to generate.

Specified by:

getMinValue in interface RandomIntegerRangeGenerator<Integer>

Returns:

the minimum

minValueTipText

public String minValueTipText()

Returns the tip text for this property.

Specified by:

minValueTipText in interface RandomIntegerRangeGenerator<Integer>

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setMaxValue

public void setMaxValue(int value)

Sets the maximum value of the numbers to generate.

Specified by:

setMaxValue in interface RandomIntegerRangeGenerator<Integer>

Parameters:

value - the maximum

getMaxValue

public int getMaxValue()

Returns the maximum value of the numbers to generate.

Specified by:

getMaxValue in interface RandomIntegerRangeGenerator<Integer>

Returns:

the maximum

maxValueTipText

public String maxValueTipText()

Returns the tip text for this property.

Specified by:

maxValueTipText in interface RandomIntegerRangeGenerator<Integer>

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

check

protected void check()

Performs optional checks.

Initializes the random number generator.

Overrides:

check in class AbstractRandomNumberGenerator<Integer>

doNext

protected Integer doNext()

Returns the next random number. Does the actual computation.

Specified by:

doNext in class AbstractRandomNumberGenerator<Integer>

Returns:

the next number