Javadoc updates.

Author: twalmsley

README.md

@@ -1,5 +1,5 @@
 # Minimal Object Description Language (MODL) Interpreter
-This Java interpreter is based on the [MODL ANTLR4 Grammar](https://github.com/MODLanguage/grammar-antlr4) and the [MODL Specification](http://www.modl.uk).
+This Java interpreter is based on the [MODL Specification](http://www.modl.uk).
 
 There are several ways the interpreter can be used:
 
@@ -42,33 +42,25 @@ The `Interpreter` class has several convenience methods, each returning a slight
 ### JSON String Result
 Convert a MODL String to a JSON String:
 ```java
-        final Interpreter interpreter = new Interpreter();
-
-        final String json = interpreter.interpretToJsonString("a=b");
+        final String json = Interpreter.interpretToJsonString("a=b");
 ```
 Use this method to generate a compact `JSON` String.
 ### Pretty JSON String Result
 Convert a MODL String to a pretty-printed JSON String:
 ```java
-        final Interpreter interpreter = new Interpreter();
-
-        final String json = interpreter.interpretToPrettyJsonString("a=b");
+        final String json = Interpreter.interpretToPrettyJsonString("a=b");
 ```
 Use this method to generate a `JSON` String for easy reading.
 ### Jackson Core JsonNode Result
 Convert a MODL String to a `JsonNode`:
 ```java
-        final Interpreter interpreter = new Interpreter();
-
-        final JsonNode jsonNode = interpreter.interpretToJsonObject("a=b");
+        final JsonNode jsonNode = Interpreter.interpretToJsonObject("a=b");
 ```
 Use this method to generate non-proprietary object for further processing.
 ### Modl Object Result
 Convert a MODL String to a `Modl` object:
 ```java
-        final Interpreter interpreter = new Interpreter();
-
-        final Modl modl = interpreter.interpret("a=b");
+        final Modl modl = Interpreter.interpret("a=b");
 ```
 Use this method to generate an object using the core model within the library, i.e. those in the `uk.modl.model` package.
 
@@ -77,4 +69,4 @@ Use this method to generate an object using the core model within the library, i
 We have a version of the interpreter in [Ruby](https://github.com/MODLanguage/ruby-interpreter), and a [JavaScript](https://www.npmjs.com/package/modl-interpreter) version.
 # Contributing
 
-Bugs and New feature requests should be raised as GitHub issues, and the community is welcome to fork the repository and submit pull requests.
+Bugs and New feature requests should be raised as GitHub issues, and the community is welcome to fork the repository and submit pull requests.

build.gradle

@@ -17,6 +17,7 @@
  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  *
  */
+//file:noinspection SpellCheckingInspection
 
 buildscript {
 
@@ -63,6 +64,7 @@ group = "uk.modl"
 applicationName = "java-interpreter"
 archivesBaseName = "java-interpreter"
 version = "1.0.0"
+mainClassName = "uk.modl.interpreter.Interpret"
 
 def isSnapshot = version.endsWith("SNAPSHOT")
 
@@ -82,7 +84,7 @@ dependencies {
     compile group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.17.1'
 
     // https://mvnrepository.com/artifact/io.vavr/vavr
-    implementation 'io.vavr:vavr:0.10.4'
+    compile 'io.vavr:vavr:0.10.4'
 
 }
 

client/index.html

@@ -31,11 +31,6 @@
  */
 @Log4j2
 public class Interpret {
-    /**
-     * The Interpreter
-     */
-    private static final Interpreter interpreter = new Interpreter();
-
     /**
      * Program entry point
      *
@@ -60,7 +55,7 @@ public static void main(final String... args) {
                         final String modlString = String.join("\n", allLines);
 
                         // Interpret to formatted JSON
-                        final String result = interpreter.interpretToPrettyJsonString(modlString);
+                        final String result = Interpreter.interpretToPrettyJsonString(modlString);
 
                         // Log the result.
                         log.info(result);

src/main/java/Interpret.java

@@ -22,6 +22,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import lombok.NonNull;
+import lombok.experimental.UtilityClass;
 import uk.modl.interpreter.model.Modl;
 import uk.modl.interpreter.parser.Parser;
 
@@ -30,6 +31,7 @@
  *
  * @author tonywalmsley
  */
+@UtilityClass
 public class Interpreter {
 
     /**
@@ -39,7 +41,7 @@ public class Interpreter {
      * @return String
      */
     public String interpretToJsonString(@NonNull final String s) {
-        final JsonNode jsonObject = this.interpretToJsonObject(s);
+        final JsonNode jsonObject = interpretToJsonObject(s);
         return JsonToString.convert(jsonObject);
     }
 
@@ -50,7 +52,7 @@ public String interpretToJsonString(@NonNull final String s) {
      * @return String
      */
     public String interpretToPrettyJsonString(@NonNull final String s) {
-        final JsonNode jsonObject = this.interpretToJsonObject(s);
+        final JsonNode jsonObject = interpretToJsonObject(s);
         return JsonToString.convertPretty(jsonObject);
     }
 
@@ -61,7 +63,7 @@ public String interpretToPrettyJsonString(@NonNull final String s) {
      * @return JsonNode
      */
     public JsonNode interpretToJsonObject(@NonNull final String s) {
-        final Modl modl = this.interpret(s);
+        final Modl modl = interpret(s);
         return ModlToJson.convert(modl);
     }
 
@@ -72,7 +74,7 @@ public JsonNode interpretToJsonObject(@NonNull final String s) {
      * @return Modl
      */
     public Modl interpret(@NonNull final String s) {
-        return new Parser().parseModl(s);
+        return Parser.parseModl(s);
     }
 
 }

src/main/java/uk/modl/interpreter/Interpreter.java

@@ -27,7 +27,7 @@
 import lombok.Value;
 
 /**
- * An object to match the ANTLR4 MODL grammar
+ * a MODL grammar object.
  */
 @Value
 public class Modl {

src/main/java/uk/modl/interpreter/model/Modl.java

@@ -26,7 +26,7 @@
 import lombok.Value;
 
 /**
- * An object to match the ANTLR4 MODL grammar
+ * a MODL grammar object.
  */
 @Value
 public class ModlArray implements ModlValue, ModlStructure {

src/main/java/uk/modl/interpreter/model/ModlArray.java

@@ -21,7 +21,7 @@
 package uk.modl.interpreter.model;
 
 /**
- * An object to match the ANTLR4 MODL grammar
+ * a MODL grammar object.
  */
 public enum ModlBoolNull implements ModlPrimitive {
     MODL_TRUE, MODL_FALSE, MODL_NULL

src/main/java/uk/modl/interpreter/model/ModlBoolNull.java

@@ -23,7 +23,7 @@
 import lombok.Value;
 
 /**
- * An object to match the ANTLR4 MODL grammar
+ * a MODL grammar object.
  */
 @Value
 public class ModlFloat implements ModlNumber {

src/main/java/uk/modl/interpreter/model/ModlFloat.java

@@ -23,7 +23,7 @@
 import lombok.Value;
 
 /**
- * An object to match the ANTLR4 MODL grammar
+ * a MODL grammar object.
  */
 @Value
 public class ModlInteger implements ModlNumber {