diff options
| author | Ben Culkin <scorpress@gmail.com> | 2020-04-13 18:32:11 -0400 |
|---|---|---|
| committer | Ben Culkin <scorpress@gmail.com> | 2020-04-13 18:32:11 -0400 |
| commit | 5a26fb2c0d899b1c80fabb39366a7b7db4d8ca41 (patch) | |
| tree | 19e19dab7c72aaee504a07e9434cde8c379092c8 /dice/src/main/java/bjc/dicelang/dicev2/ComparePoints.java | |
| parent | 25fbdca78518df0cb096544e912cdb3913f348fd (diff) | |
Add some javadoc
Add some javadoc comments
Diffstat (limited to 'dice/src/main/java/bjc/dicelang/dicev2/ComparePoints.java')
| -rw-r--r-- | dice/src/main/java/bjc/dicelang/dicev2/ComparePoints.java | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/dice/src/main/java/bjc/dicelang/dicev2/ComparePoints.java b/dice/src/main/java/bjc/dicelang/dicev2/ComparePoints.java index 4e08c3e..81b5cbe 100644 --- a/dice/src/main/java/bjc/dicelang/dicev2/ComparePoints.java +++ b/dice/src/main/java/bjc/dicelang/dicev2/ComparePoints.java @@ -2,15 +2,35 @@ package bjc.dicelang.dicev2; import java.util.function.LongPredicate; +/** + * Utility class for creating compare points. + * @author Ben Culkin + * + */ public class ComparePoints { + /** + * Create a compare point for checking 'less than' + * @param val The value to check if we are less than. + * @return A compare point that does the specified check. + */ public static LongPredicate isLess(long val) { return (arg) -> arg < val; } - + + /** + * Create a compare point for checking 'equals' + * @param val The value to check if we are equal to. + * @return A compare point that does the specified check. + */ public static LongPredicate isEqual(long val) { return (arg) -> arg == val; } - + + /** + * Create a compare point for checking 'greater than' + * @param val The value to check if we are greater than. + * @return A compare point that does the specified check. + */ public static LongPredicate isGreater(long val) { return (arg) -> arg > val; } |
