From 01cb9f504c860bc1c037a44f3a76bf342a293d46 Mon Sep 17 00:00:00 2001
From: bculkin2442 <bjculkin@mix.wvu.edu>
Date: Tue, 22 Mar 2016 12:28:35 -0400
Subject: General formatting cleanup and documentation update

---
 .../java/bjc/utils/dice/ast/DiceASTParser.java     | 70 +++++++++++++++-------
 1 file changed, 50 insertions(+), 20 deletions(-)

(limited to 'BJC-Utils2/src/main/java/bjc/utils/dice/ast/DiceASTParser.java')

diff --git a/BJC-Utils2/src/main/java/bjc/utils/dice/ast/DiceASTParser.java b/BJC-Utils2/src/main/java/bjc/utils/dice/ast/DiceASTParser.java
index d56ad0e..b25f5b4 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/dice/ast/DiceASTParser.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/dice/ast/DiceASTParser.java
@@ -8,7 +8,16 @@ import bjc.utils.parserutils.AST;
 import bjc.utils.parserutils.ShuntingYard;
 import bjc.utils.parserutils.TreeConstructor;
 
+/**
+ * Create an AST from a string expression
+ * 
+ * @author ben
+ *
+ */
 public class DiceASTParser {
+	/**
+	 * The yard to use for shunting expressions
+	 */
 	private static ShuntingYard<String> yard;
 
 	static {
@@ -22,14 +31,21 @@ public class DiceASTParser {
 		// expression
 	}
 
+	/**
+	 * Build an AST from a string expression
+	 * 
+	 * @param exp
+	 *            The string to build from
+	 * @return An AST built from the passed in string
+	 */
 	public AST<IDiceASTNode> buildAST(String exp) {
-		FunctionalList<String> tokens = FunctionalStringTokenizer
-				.fromString(exp).toList((s) -> s);
+		FunctionalList<String> tokens =
+				FunctionalStringTokenizer.fromString(exp).toList((s) -> s);
 
 		FunctionalList<String> shunted = yard.postfix(tokens, (s) -> s);
 
-		AST<String> rawAST = TreeConstructor.constructTree(shunted,
-				this::isOperator);
+		AST<String> rawAST =
+				TreeConstructor.constructTree(shunted, this::isOperator);
 
 		AST<IDiceASTNode> bakedAST = rawAST.transmuteAST((tok) -> {
 			if (isOperator(tok)) {
@@ -44,22 +60,14 @@ public class DiceASTParser {
 		return bakedAST;
 	}
 
-	private boolean isOperator(String tok) {
-		switch (tok) {
-			case ":=":
-			case "+":
-			case "-":
-			case "*":
-			case "/":
-			case "c":
-			case "d":
-				return true;
-			default:
-				return false;
-		}
-	}
-
-	private boolean isLiteral(String tok) {
+	/**
+	 * Check if a token represents a literal
+	 * 
+	 * @param tok
+	 *            The token to check
+	 * @return Whether or not the token represents a literal
+	 */
+	private static boolean isLiteral(String tok) {
 		if (StringUtils.countMatches(tok, 'c') == 1
 				&& !tok.equalsIgnoreCase("c")) {
 			return true;
@@ -75,4 +83,26 @@ public class DiceASTParser {
 			}
 		}
 	}
+
+	/**
+	 * Check if a token represents an operator
+	 * 
+	 * @param tok
+	 *            The token to check if it represents an operator
+	 * @return Whether or not the token represents an operator
+	 */
+	private boolean isOperator(String tok) {
+		switch (tok) {
+			case ":=":
+			case "+":
+			case "-":
+			case "*":
+			case "/":
+			case "c":
+			case "d":
+				return true;
+			default:
+				return false;
+		}
+	}
 }
-- 
cgit v1.2.3