summaryrefslogtreecommitdiff
path: root/dice-lang/src/main/java/bjc/dicelang/IDiceExpression.java
blob: c6aa0a7b8b64fc2ffc453fc3d59f52f7be1df31a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
package bjc.dicelang;

/**
 * An expression for something that can be rolled like a polyhedral die
 * 
 * @author ben
 *
 */
@FunctionalInterface
public interface IDiceExpression {
	/**
	 * Roll the dice once
	 * 
	 * @return The result of rowing the dice
	 */
	public int roll();

	/**
	 * Optimize this expression to a scalar value
	 * 
	 * @return This expression, optimized to a scalar value
	 * 
	 * @throws UnsupportedOperationException
	 *             if this type of expression can't be optimized
	 */
	public default int optimize() {
		throw new UnsupportedOperationException(
				"Can't optimize this type of expression");
	}

	/**
	 * Check if this expression can be optimized to a scalar value
	 * 
	 * @return Whether or not this expression can be optimized to a scalar
	 *         value
	 */
	public default boolean canOptimize() {
		return false;
	}
}