Class Dice

java.lang.Object

Dice

public class Dice
extends Object

Dice group for random rolls.

Since:

2014-05-20

Field Summary

Fields

Modifier and Type	Field and Description
private int	addition Addition to the dice (negative = subtraction).
private int	multiplier Multiplier to the dice (negative = divisor).
private int	number Number of dice.
private static Random	random Random number generator.
private int	sides Sides on the dice.

Constructor Summary

Constructors

Constructor and Description
Dice(Dice d) Constructor (copy).
Dice(int sides) Constructor (one die only).
Dice(int num, int sides) Constructor (number, sides).
Dice(int num, int sides, int add) Constructor (number, sides, addition).
Dice(int number, int sides, int mul, int add) Constructor (all fields).
Dice(String s) Constructor (read from string descriptor).

Method Summary

Modifier and Type	Method and Description
int	getAdd()
int	getMul()
int	getNum()
int	getSides()
static void	initialize() Initialize the dice random generator.
static void	main(String[] args) Main test function.
int	maxRoll() Compute the maximum possible roll.
String	reportRoll() Get a string description of a roll.
int	roll() Rolls the dice.
static int	roll(int sides) Roll one die from a static context.
int	rollPlus(int modifier) Rolls the dice with added modifier.
void	setAdd(int add)
void	setMul(int mul)
void	setNum(int num)
void	setSides(int sides)
String	toString() Identify this object as a string.

Methods inherited from class java.lang.Object

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

Field Detail

number

private int number

Number of dice.

sides

private int sides

Sides on the dice.

multiplier

private int multiplier

Multiplier to the dice (negative = divisor).

addition

private int addition

Addition to the dice (negative = subtraction).

random

private static Random random

Random number generator. Maintaining our own generator is more efficient than calls to the Math routine in a dice-heavy program; (1) we avoid checks for null random; (2) we can call nextInt directly and avoid conversion back-and-forth with double.

Constructor Detail

Dice

Dice(int sides)

Constructor (one die only).

Dice

Dice(int num,
     int sides)

Constructor (number, sides).

Dice

Dice(int num,
     int sides,
     int add)

Constructor (number, sides, addition).

Dice

Dice(int number,
     int sides,
     int mul,
     int add)

Constructor (all fields).

Dice

Dice(String s)

Constructor (read from string descriptor). RegEx code from @user1803551 on StackExchange: http://stackoverflow.com/questions/35020687/ how-to-parse-dice-notation-with-a-java-regular-expression

Dice

public Dice(Dice d)

Constructor (copy).

Method Detail

getNum

public int getNum()

getSides

public int getSides()

getMul

public int getMul()

getAdd

public int getAdd()

setNum

public void setNum(int num)

setSides

public void setSides(int sides)

setMul

public void setMul(int mul)

setAdd

public void setAdd(int add)

initialize

public static void initialize()

Initialize the dice random generator. Must call this before any roll() methods.

roll

public static int roll(int sides)

Roll one die from a static context.

Returns:

The die-roll.

roll

public int roll()

Rolls the dice.

Returns:

The dice-roll, minimum 1.

rollPlus

public int rollPlus(int modifier)

Rolls the dice with added modifier.

Returns:

The dice-roll, minimum 1.

maxRoll

public int maxRoll()

Compute the maximum possible roll.

Returns:

Maximum possible roll.

toString

public String toString()

Identify this object as a string.

Overrides:

toString in class Object

reportRoll

public String reportRoll()

Get a string description of a roll.

main

public static void main(String[] args)

Main test function.