summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/dice/DiceExpressionBuilder.java
diff options
context:
space:
mode:
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils/dice/DiceExpressionBuilder.java')
-rw-r--r--BJC-Utils2/src/main/java/bjc/utils/dice/DiceExpressionBuilder.java108
1 files changed, 99 insertions, 9 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/dice/DiceExpressionBuilder.java b/BJC-Utils2/src/main/java/bjc/utils/dice/DiceExpressionBuilder.java
index bcfbb81..6dcd5e3 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/dice/DiceExpressionBuilder.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/dice/DiceExpressionBuilder.java
@@ -2,60 +2,150 @@ package bjc.utils.dice;
import static bjc.utils.dice.DiceExpressionType.*;
+/**
+ * Build a dice expression piece by piece
+ *
+ * @author ben
+ *
+ */
public class DiceExpressionBuilder {
- private DiceExpression baking;
+ /**
+ * The dice expression we are building
+ */
+ private IDiceExpression baking;
- public DiceExpressionBuilder(Dice firstDice) {
+ /**
+ * Build a dice expresssion from a seed dice
+ *
+ * @param firstDice
+ * The dice to use as a seed
+ */
+ public DiceExpressionBuilder(LazyDice firstDice) {
baking = firstDice;
}
- public DiceExpressionBuilder(DiceExpression seed) {
+ /**
+ * Build a dice expression from a seed dice expression
+ *
+ * @param seed
+ * The dice expression to use as a seed
+ */
+ public DiceExpressionBuilder(IDiceExpression seed) {
baking = seed;
}
+ /**
+ * Build a dice expression from a seed dice
+ *
+ * @param nSides
+ * The number of sides in the dice
+ * @param nDice
+ * The number of dice in the group
+ */
public DiceExpressionBuilder(int nSides, int nDice) {
- baking = new Dice(nSides, nDice);
+ baking = new LazyDice(nSides, nDice);
}
- public DiceExpressionBuilder add(DiceExpression exp) {
+ /**
+ * Add a term to this dice expression
+ *
+ * @param exp
+ * The expression to use on the left
+ * @return A new expression adding the two dice
+ */
+ public DiceExpressionBuilder add(IDiceExpression exp) {
baking = new CompoundDiceExpression(baking, exp, ADD);
return this;
}
+ /**
+ * Add a scalar to this dice
+ *
+ * @param num
+ * The scalar to add to the dice
+ * @return A dice expression adding a scalar to this
+ */
public DiceExpressionBuilder add(int num) {
baking = new ScalarDiceExpression(baking, num, ADD);
return this;
}
- public DiceExpression bake() {
+ /**
+ * Bake the expression being built to completion
+ *
+ * @return A usable dice expression
+ */
+ public IDiceExpression bake() {
return baking;
}
- public DiceExpressionBuilder divide(DiceExpression exp) {
+ /**
+ * Divide a term from dice expression
+ *
+ * @param exp
+ * The expression to use on the left
+ * @return A new expression dividing the two dice
+ */
+ public DiceExpressionBuilder divide(IDiceExpression exp) {
baking = new CompoundDiceExpression(baking, exp, DIVIDE);
return this;
}
+ /**
+ * Divide a scalar from this dice
+ *
+ * @param num
+ * The scalar to add to the dice
+ * @return A dice expression dividing a scalar from this
+ */
public DiceExpressionBuilder divide(int num) {
baking = new ScalarDiceExpression(baking, num, DIVIDE);
return this;
}
- public DiceExpressionBuilder multiply(DiceExpression exp) {
+ /**
+ * Multiply a term by this dice expression
+ *
+ * @param exp
+ * The expression to use on the left
+ * @return A new expression multiplying the two dice
+ */
+ public DiceExpressionBuilder multiply(IDiceExpression exp) {
baking = new CompoundDiceExpression(baking, exp, MULTIPLY);
return this;
}
+ /**
+ * Multiply a scalar by this dice
+ *
+ * @param num
+ * The scalar to multiply to the dice
+ * @return A dice expression multiplying a scalar to this
+ */
public DiceExpressionBuilder multiply(int num) {
baking = new ScalarDiceExpression(baking, num, MULTIPLY);
return this;
}
- public DiceExpressionBuilder subtract(DiceExpression exp) {
+ /**
+ * Add a term to this dice expression
+ *
+ * @param exp
+ * The expression to use on the left
+ * @return A new expression adding the two dice
+ */
+ public DiceExpressionBuilder subtract(IDiceExpression exp) {
baking = new CompoundDiceExpression(baking, exp, SUBTRACT);
return this;
}
+ /**
+ * Add a scalar to this dice
+ *
+ * @param num
+ * The scalar to add to the dice
+ * @return A dice expression adding a scalar to this
+ */
public DiceExpressionBuilder subtract(int num) {
baking = new ScalarDiceExpression(baking, num, SUBTRACT);
return this;