From 9139064c95f6c9c4f7ba1d0aea21e2f5233ad188 Mon Sep 17 00:00:00 2001 From: bculkin2442 Date: Mon, 6 Mar 2017 14:15:03 -0500 Subject: Formatting/Documentation --- dice-lang/src/bjc/dicelang/dice/DieList.java | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) (limited to 'dice-lang/src/bjc/dicelang/dice/DieList.java') diff --git a/dice-lang/src/bjc/dicelang/dice/DieList.java b/dice-lang/src/bjc/dicelang/dice/DieList.java index a55f2b9..5454759 100644 --- a/dice-lang/src/bjc/dicelang/dice/DieList.java +++ b/dice-lang/src/bjc/dicelang/dice/DieList.java @@ -1,8 +1,30 @@ package bjc.dicelang.dice; +/** + * Represents a group of dice. + * + * @author Ben Culkin. + */ public interface DieList { + /** + * Can this list be optimized? + * + * @return Whether or not this list cna be optimized. + */ boolean canOptimize(); + /** + * Optimize this list, if it can be done. + * + * Invoking this on unoptimizable expression is undefined. + * + * @return The optimized form of this list. + */ long[] optimize(); + /** + * Roll this group of dice. + * + * @param A possible roll of this group. + */ long[] roll(); -} \ No newline at end of file +} -- cgit v1.2.3