Tidy/lombok

Change-Id: Ie312f385f4e72c599c9d5357f46e38f80cd45f98
Reviewed-on: http://gerrit.dmdirc.com/2430
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/addons/calc/Evaluator.java

@@ -22,26 +22,18 @@
 
 package com.dmdirc.addons.calc;
 
+import lombok.RequiredArgsConstructor;
+
 /**
  * A simple evaluator which just requests that the {@link TreeToken} evaluates
  * itself.
- *
- * @author chris
  */
+@RequiredArgsConstructor
 public class Evaluator {
 
     /** The token to be evaluated. */
     private final TreeToken node;
 
-    /**
-     * Creates a new evaluator for the specified token.
-     *
-     * @param node The token to be evaluated
-     */
-    public Evaluator(final TreeToken node) {
-        this.node = node;
-    }
-
     /**
      * Evaluates the token and returns the numeric result.
      *

src/com/dmdirc/addons/calc/Lexer.java

@@ -30,13 +30,11 @@ import java.util.List;
 /**
  * The lexer takes a String input and produces an ordered list of {@link Token}s
  * corresponding to the input.
- *
- * @author chris
  */
 public class Lexer {
 
     /** The input string. */
-    final String input;
+    private final String input;
 
     /**
      * Creates a new lexer for the specified input string.

src/com/dmdirc/addons/calc/Parser.java

@@ -29,19 +29,21 @@ import java.util.Collections;
 import java.util.Comparator;
 import java.util.List;
 
+import lombok.RequiredArgsConstructor;
+
 /**
  * The parser takes the output from a {@link Lexer} and applies precdence rules
  * to build the tokens into a tree.
- *
- * @author chris
  */
+@RequiredArgsConstructor
 public class Parser {
 
-    /** The lexer whose output will be parsed. */
-    protected final Lexer lexer;
     /** A list of token types sorted by their precendece. */
     protected static final List<TokenType> TOKENS_BY_PRECEDENCE;
 
+    /** The lexer whose output will be parsed. */
+    protected final Lexer lexer;
+
     static {
         TOKENS_BY_PRECEDENCE = new ArrayList<TokenType>(Arrays.asList(
                 TokenType.values()));
@@ -49,15 +51,6 @@ public class Parser {
                 new TokenTypePrecedenceComparator());
     }
 
-    /**
-     * Creates a new parser for the specified lexer.
-     *
-     * @param lexer The lexer whose output should be parsed
-     */
-    public Parser(final Lexer lexer) {
-        this.lexer = lexer;
-    }
-
     /**
      * Parses the output of this parser's lexer, and returns a {@link TreeToken}
      * representing the parsed formula.

src/com/dmdirc/addons/calc/Token.java

@@ -22,12 +22,18 @@
 
 package com.dmdirc.addons.calc;
 
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.ToString;
+
 /**
  * Describes a distinct piece of a mathematical formula, as tokenised by a
  * {@link Lexer}.
- *
- * @author chris
  */
+@Getter
+@ToString
+@RequiredArgsConstructor
+@SuppressWarnings("PMD.UnusedPrivateField")
 public class Token {
 
     /** The type of this token. */
@@ -36,39 +42,4 @@ public class Token {
     /** The content of this token, if any. */
     private final String content;
 
-    /**
-     * Creates a new token.
-     *
-     * @param type The type of the token
-     * @param content The content of the token
-     */
-    public Token(final TokenType type, final String content) {
-        this.type = type;
-        this.content = content;
-    }
-
-    /**
-     * Retrieves the content of this token.
-     *
-     * @return This token's content
-     */
-    public String getContent() {
-        return content;
-    }
-
-    /**
-     * Retrieves the type of this token.
-     *
-     * @return This token's type
-     */
-    public TokenType getType() {
-        return type;
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public String toString() {
-        return "[type: " + type + "; content: " + content + "]";
-    }
-
 }

src/com/dmdirc/addons/calc/TokenType.java

@@ -27,12 +27,13 @@ import java.util.List;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import lombok.Getter;
+
 /**
  * Describes the different types of possible token, their arities, precedence,
  * and the types of token that may follow them.
- *
- * @author chris
  */
+@SuppressWarnings("PMD.UnusedPrivateField")
 public enum TokenType {
 
     /** The start of an input string. */
@@ -150,12 +151,14 @@ public enum TokenType {
     /** The string representation of tokens that may follow this one. */
     private final String[] strfollows;
     /** The precedence of this token. */
+    @Getter
     private final int precedence;
     /** The list of tokens that may follow this one. */
     private List<TokenType> follows;
     /** The regular expression used to match this token. */
     private final Pattern regex;
     /** The arity of this token. */
+    @Getter
     private final TokenTypeArity arity;
 
     /**
@@ -191,24 +194,6 @@ public enum TokenType {
         return follows;
     }
 
-    /**
-     * Retrieves the arity of this token type.
-     *
-     * @return This token type's arity
-     */
-    public TokenTypeArity getArity() {
-        return arity;
-    }
-
-    /**
-     * Retrieves the precedence of this token type.
-     *
-     * @return This token type's precedence
-     */
-    public int getPrecedence() {
-        return precedence;
-    }
-
     /**
      * Attempts to match this token type against the specified input string
      * (starting at the specified offset).

src/com/dmdirc/addons/calc/TokenTypeArity.java

@@ -24,8 +24,6 @@ package com.dmdirc.addons.calc;
 
 /**
  * Describes the arity (number of operands) of a token type.
- *
- * @author chris
  */
 public enum TokenTypeArity {
 

src/com/dmdirc/addons/calc/TreeToken.java

@@ -25,49 +25,30 @@ package com.dmdirc.addons.calc;
 import java.util.ArrayList;
 import java.util.List;
 
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.ToString;
+
 /**
  * Describes a tree of {@link Token}s.
- *
- * @author chris
  */
+@ToString
+@RequiredArgsConstructor
+@SuppressWarnings("PMD.UnusedPrivateField")
 public class TreeToken {
 
     /** The children of this node. */
+    @Getter
     private final List<TreeToken> children = new ArrayList<TreeToken>();
 
     /** The token at the root of the tree. */
+    @Getter
     private final Token token;
 
     /** Whether or not this tree has been processed. */
+    @Getter
     private boolean processed = false;
 
-    /**
-     * Creates a new tree with the specified token at the root.
-     *
-     * @param token The root token
-     */
-    public TreeToken(final Token token) {
-        this.token = token;
-    }
-
-    /**
-     * Retrieves the (direct) children of this tree.
-     *
-     * @return This tree's children
-     */
-    public List<TreeToken> getChildren() {
-        return children;
-    }
-
-    /**
-     * Retrieves the root token of this tree.
-     *
-     * @return This tree's token
-     */
-    public Token getToken() {
-        return token;
-    }
-
     /**
      * Adds the specified child to this tree.
      *
@@ -77,15 +58,6 @@ public class TreeToken {
         children.add(token);
     }
 
-    /**
-     * Determines if this tree has been processed.
-     *
-     * @return True if the tree has been processed, false otherwise
-     */
-    public boolean isProcessed() {
-        return processed;
-    }
-
     /**
      * Sets the processed flag of this tree to true.
      */
@@ -102,11 +74,4 @@ public class TreeToken {
         return token.getType().evaluate(this);
     }
 
-    /** {@inheritDoc} */
-    @Override
-    public String toString() {
-        return "[token: " + token + "; children: " + children + "; processed: "
-                + processed + "]";
-    }
-
 }