Added documentation

Author: fugerit79

README.md

@@ -31,11 +31,23 @@ This project provides just a convenient interface for evaluating scripts with ja
 Sample code : 
 
 ```java
-EvalScript evalKts = new EvalScriptWithJsonDataModel( "kts" );
+// this will create a EvalScript instance for : 
+// kotlin script engine (kts)
+// data model will be bound as "data" (if not provided this is the default binding name)
+EvalScript evalKts = new EvalScriptWithDataModel( "kts", "data" );
 try (Reader reader = [reader on kotlin script]) {
     Map<String, Object> dataModel = new HashMap<>();
     dataModel.put( "docTitle", "My custom title" );
     Object result = evalKts.evalKts( reader, dataModel );
     log.info( "my result : {}", result );
 }
-```
+```
+
+It is possible to wrap the EvalScript with some decorators, for instance : 
+
+```java
+EvalScript evalKts = EvalScriptWithJsonDataModel( new EvalScriptWithDataModel( "kts", "data" ) );
+```
+
+Will wraps the EvalScript with EvalScriptWithJsonDataModel decorator.
+EvalScriptWithJsonDataModel will transform a Map data model to a json data model style.

src/main/java/org/fugerit/java/script/helper/EvalScript.java

@@ -5,18 +5,55 @@
 import java.io.Reader;
 import java.util.Map;
 
+/**
+ * Simple interface for script handling.
+ */
 public interface EvalScript {
 
+    /**
+     * It will handle a script and bind a data model.
+     *
+     * Any exception will be converted to {@link org.fugerit.java.core.cfg.ConfigRuntimeException}
+     *
+     * @param reader        the reader over script
+     * @param dataModel     the data model to bind
+     * @return              the result of script processing
+     */
     default Object handle(Reader reader, Map<String, Object> dataModel) {
         return SafeFunction.get( () -> handleEx(reader, dataModel) );
     }
 
+    /**
+     * It will handle a script with no data model
+     *
+     * Any exception will be converted to {@link org.fugerit.java.core.cfg.ConfigRuntimeException}
+     *
+     * @param reader        the reader over script
+     * @return              the result of script processing
+     */
     default Object handle(Reader reader) {
         return handle(reader, null);
     }
 
+    /**
+     * It will handle a script and bind a data model.
+     *
+     * Any class implementing EvalScript will need to provide at least this method.
+     *
+     * @param reader        the reader over script
+     * @param dataModel     the data model to bind
+     * @return              the result of script processing
+     * @throws ScriptException  in case of script handling issues
+     */
     Object handleEx(Reader reader, Map<String, Object> dataModel) throws ScriptException;
 
+    /**
+     * It will handle a script with no data model.
+     *
+     * @param reader        the reader over script
+     * @return              the result of script processing
+     * @throws ScriptException  in case of script handling issues
+     */
     default Object handleEx(Reader reader) throws ScriptException {
         return handleEx(reader, null);
     }

src/main/java/org/fugerit/java/script/helper/EvalScriptWithDataModel.java

@@ -12,6 +12,14 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+/**
+ * Simple implementation of EvalScript.
+ *
+ * It relies on extension based ScriptEngine (ScriptEngineManager.getEngineByExtension( this.scriptExtension ))
+ *
+ * Data model binding name can be customized, default is 'data'.
+ *
+ */
 @Slf4j
 public class EvalScriptWithDataModel implements EvalScript {
 
@@ -21,12 +29,23 @@ public class EvalScriptWithDataModel implements EvalScript {
 
     private String dataModelBindingName;
 
+    /**
+     * It will create a EvalScriptWithDataModel
+     *
+     * @param scriptExtension           the extension to be used for the ScriptEngine
+     * @param dataModelBindingName      the data model binding name
+     */
     public EvalScriptWithDataModel(String scriptExtension, String dataModelBindingName) {
         this.scriptExtension = scriptExtension;
         this.dataModelBindingName = dataModelBindingName;
         log.debug( "use scriptExtension : [{}], use dataModelBindingName : [{}]s", scriptExtension, dataModelBindingName );
     }
 
+    /**
+     * It will create a EvalScriptWithDataModel with the default data model binding name.
+     *
+     * @param scriptExtension           the extension to be used for the ScriptEngine
+     */
     public EvalScriptWithDataModel(String scriptExtension) {
         this( scriptExtension, DEFAULT_DATA_MODEL_BINDING_NAME );
     }

src/main/java/org/fugerit/java/script/helper/EvalScriptWithJsonDataModel.java

@@ -7,13 +7,23 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+/**
+ * EvalScript decorator.
+ *
+ * The Map<String, Object> dataModel will be transformed into a json styled LinkedHashMap<String, Object>.
+ */
 @Slf4j
 public class EvalScriptWithJsonDataModel implements EvalScript {
 
     private static final ObjectMapper MAPPER = new ObjectMapper();
 
     private EvalScript evalScript;
 
+    /**
+     * Add decoration to a give EvalScript
+     *
+     * @param evalScript    the EvalScript instance to decorate
+     */
     public EvalScriptWithJsonDataModel(EvalScript evalScript) {
         this.evalScript = evalScript;
     }
@@ -28,10 +38,23 @@ public Object handleEx(Reader reader, Map<String, Object> dataModel) throws Scri
         }
     }
 
+    /**
+     * It will decorate a EvalScriptWithDataModel instance.
+     *
+     * @param scriptExtension           the extension to be used for the ScriptEngine
+     * @param dataModelBindingName      the data model binding name
+     * @return  the new EvalScript
+     */
     public static EvalScript newEvalScriptWithJsonDataModel( String scriptExtension, String dataModelBindingName ) {
         return new EvalScriptWithJsonDataModel( new EvalScriptWithDataModel( scriptExtension, dataModelBindingName ) );
     }
 
+    /**
+     * It will decorate a EvalScriptWithDataModel instance with default data model binding name.
+     *
+     * @param scriptExtension           the extension to be used for the ScriptEngine
+     * @return  the new EvalScript
+     */
     public static EvalScript newEvalScriptWithJsonDataModel( String scriptExtension ) {
         return new EvalScriptWithJsonDataModel( new EvalScriptWithDataModel( scriptExtension ) );
     }