add API Doc to tree package

Author: celadari

src/main/scala/com/celadari/jsonlogicscala/evaluate/EvaluatorLogic.scala

@@ -62,7 +62,7 @@ class EvaluatorLogic(implicit val conf: EvaluatorLogicConf) {
   // scalastyle:off return null
   protected[this] def evaluateValueLogic(condition: ValueLogic[_]): Any = {
     val value = condition.valueOpt.get
-    val typeValueOpt = condition.typeCodenameOpt
+    val typeValueOpt = condition.typeOpt
     if (typeValueOpt.isEmpty) return null
 
     val evaluatorClassOpt = conf.valueLogicTypeToReducer.get(typeValueOpt.get)

src/main/scala/com/celadari/jsonlogicscala/serialize/Serializer.scala

@@ -108,7 +108,7 @@ class Serializer(implicit val conf: SerializerConf) {
     val (jsType, jsonLogicDatum) = valueLogic
       .valueOpt
       .map(value => {
-        val typeCodenameOpt = valueLogic.typeCodenameOpt
+        val typeCodenameOpt = valueLogic.typeOpt
         if (typeCodenameOpt.isEmpty) throw new InvalidValueLogicException("ValueLogic with defined value must define a typeCodename as well")
         val marshaller = getMarshaller(typeCodenameOpt.get)
         (Json.toJson(typeCodenameOpt.get), marshaller.marshal(value))

src/main/scala/com/celadari/jsonlogicscala/tree/ComposeLogic.scala

@@ -1,10 +1,14 @@
+// Copyright 2019 celadari. All rights reserved. MIT license.
 package com.celadari.jsonlogicscala.tree
 
 import play.api.libs.json.{JsResult, JsValue, Reads, Writes}
 import com.celadari.jsonlogicscala.deserialize.Deserializer
 import com.celadari.jsonlogicscala.serialize.Serializer
 
 
+/**
+ * Companion object holding implicit reader and writer json.
+ */
 object ComposeLogic {
 
   implicit def composeLogicReads(implicit deserializer: Deserializer): Reads[ComposeLogic] = new Reads[ComposeLogic] {
@@ -21,9 +25,25 @@ object ComposeLogic {
   def unapply(composeLogic: ComposeLogic): Some[(String, Array[JsonLogicCore])] = Some((composeLogic.operator, composeLogic.conditions))
 }
 
+/**
+ * Represents an internal node in syntax tree. It is an operator node.
+ * Scala data structures representing expressions from json-logic-typed format are based on abstract syntax tree.
+ * @param operator: string codename.
+ * @param _conditions: children [[JsonLogicCore]] nodes. They are the operands the operator must be applied to.
+ */
 class ComposeLogic(override val operator: String, private[this] var _conditions: Array[JsonLogicCore]) extends JsonLogicCore(operator) {
 
+  /**
+   * Returns array of children nodes.
+   * @return _conditions.
+   */
   def conditions: Array[JsonLogicCore] = _conditions
+
+  /**
+   * Sets children nodes.
+   * Useful with composed operators.
+   * @param conds: new set of children nodes array.
+   */
   def conditions_=(conds: Array[JsonLogicCore]): Unit = _conditions = conds
 
 }

src/main/scala/com/celadari/jsonlogicscala/tree/JsonLogicCore.scala

@@ -1,10 +1,15 @@
+// Copyright 2019 celadari. All rights reserved. MIT license.
 package com.celadari.jsonlogicscala.tree
 
 import play.api.libs.json._
 import com.celadari.jsonlogicscala.deserialize.Deserializer
 import com.celadari.jsonlogicscala.serialize.Serializer
 
 
+/**
+ * Companion object holding implicit reader and writer json.
+ * Also defines methods to traverse abstract syntax tree and return string representation.
+ */
 object JsonLogicCore {
 
   implicit def jsonLogicCoreReads(implicit deserializer: Deserializer): Reads[JsonLogicCore] = new Reads[JsonLogicCore] {
@@ -31,6 +36,13 @@ object JsonLogicCore {
     }
   }
 
+  /**
+   * Returns string representation of JsonLogicCore object. Used for root node.
+   * @param jsonLogicCore: the [[com.celadari.jsonlogicscala.tree.JsonLogicCore]] to be represented in tree view.
+   * @param errorConditionOpt: optional node in tree view representing an error node. Used during evaluation if something
+   * goes wrong.
+   * @return string tree view of [[com.celadari.jsonlogicscala.tree.JsonLogicCore]].
+   */
   def traverseRoot(jsonLogicCore: JsonLogicCore, errorConditionOpt: Option[JsonLogicCore]): String = {
     val errorString = errorConditionOpt.filter(_ == jsonLogicCore).map(_ => "ERROR AT: ").getOrElse("")
 
@@ -59,6 +71,14 @@ object JsonLogicCore {
     }
   }
 
+  /**
+   * Returns string representation of JsonLogicCore object. Used for non root node.
+   * @param sb: string builder that is used to accumulate string as syntax tree is traversed.
+   * @param padding: prefix/space from left to right between parent and children.
+   * @param pointer: defines if first|internal|last child node.
+   * @param jsonLogicCore: node to be explored.
+   * @param errorConditionOpt: optional error node to be highlighted in final string representation.
+   */
   def traverseNodes(
                      sb: StringBuilder,
                      padding: String,
@@ -102,9 +122,17 @@ object JsonLogicCore {
 
 }
 
-
+/**
+ * Represents a json-logic-typed scala data structure.
+ * Scala data structures representing expressions from json-logic-typed format are based on abstract syntax tree.
+ * @param operator: name of operator this object represents.
+ */
 abstract class JsonLogicCore(val operator: String) {
 
+  /**
+   * Returns a string tree view of the expression this object represents.
+   * @return string tree view.
+   */
   def treeString: String = {
     JsonLogicCore.traverseRoot(this, None)
   }

src/main/scala/com/celadari/jsonlogicscala/tree/ValueLogic.scala

@@ -1,3 +1,4 @@
+// Copyright 2019 celadari. All rights reserved. MIT license.
 package com.celadari.jsonlogicscala.tree
 
 import java.util.UUID
@@ -7,6 +8,9 @@ import com.celadari.jsonlogicscala.exceptions.TreeException
 import com.celadari.jsonlogicscala.tree.types.TypeValue
 
 
+/**
+ * Companion object holding implicit reader json.
+ */
 object ValueLogic {
   val OPERATOR_CODENAME: String = "var"
 
@@ -17,9 +21,19 @@ object ValueLogic {
   }
 }
 
+
+/**
+ * Represents a leaf node in syntax tree. It is a data node.
+ * Scala data structures representing expressions from json-logic-typed format are based on abstract syntax tree.
+ * @param valueOpt: optional data value represented by this node.
+ * @param typeOpt: optional [[com.celadari.jsonlogicscala.tree.types.TypeValue]]. None value only under composed operators (advanced use).
+ * @param variableNameOpt: optional string of variableNameOpt. Only defined under composed operators.
+ * @param pathNameOpt: optional string to represent name of data in json-format-type. Also used as variable name under composed operators.
+ * @note inherited operator has fixed value of "var".
+ */
 case class ValueLogic[T](
                           valueOpt: Option[T],
-                          typeCodenameOpt: Option[TypeValue] = None,
+                          typeOpt: Option[TypeValue] = None,
                           variableNameOpt: Option[String] = None,
                           pathNameOpt: Option[String] = Some(UUID.randomUUID().toString)
                         ) extends JsonLogicCore(ValueLogic.OPERATOR_CODENAME) {

src/main/scala/com/celadari/jsonlogicscala/tree/VariableLogic.scala

@@ -1,5 +1,13 @@
+// Copyright 2019 celadari. All rights reserved. MIT license.
 package com.celadari.jsonlogicscala.tree
 
+
+/**
+ * Represents an internal node in syntax tree. It is an operator node that represents a variable node in a composed operator.
+ * Scala data structures representing expressions from json-logic-typed format are based on abstract syntax tree.
+ * @param variableName: string codename.
+ * @param composeOperator: sub-parent node this node is variable of.
+ */
 case class VariableLogic(
                           variableName: String,
                           composeOperator: ComposeLogic

src/main/scala/com/celadari/jsonlogicscala/tree/types/AnyTypeValue.scala

@@ -1,8 +1,15 @@
+// Copyright 2019 celadari. All rights reserved. MIT license.
 package com.celadari.jsonlogicscala.tree.types
 
 import play.api.libs.json.{JsValue, Writes}
 
 
+/**
+ * Represents an unknown type. Evaluating, serializing, deserializing a tree with a leaf node with
+ * [[com.celadari.jsonlogicscala.tree.types.AnyTypeValue]] as typeOpt parameters throws an exception.
+ * Can only be used to manipulate a [[com.celadari.jsonlogicscala.tree.ValueLogic]] as temporary scala data structure
+ * before setting correct typeOpt parameter.
+ */
 object AnyTypeValue extends TypeValue("anyTypeValue") {
   val CODENAME_TYPE: String = codename
 

src/main/scala/com/celadari/jsonlogicscala/tree/types/ArrayTypeValue.scala

@@ -1,8 +1,12 @@
+// Copyright 2019 celadari. All rights reserved. MIT license.
 package com.celadari.jsonlogicscala.tree.types
 
 import play.api.libs.json.{JsValue, Writes}
 
 
+/**
+ * Companion object holding implicit writer json and constant codename for [[com.celadari.jsonlogicscala.tree.types.ArrayTypeValue]].
+ */
 object ArrayTypeValue {
   val CODENAME_TYPE: String = "array"
 
@@ -11,4 +15,9 @@ object ArrayTypeValue {
   }
 }
 
+/**
+ * Represents a Array[paramType] type.
+ * @param paramType: parameter type this array is of.
+ * @note inherited operator has fixed value of "array".
+ */
 case class ArrayTypeValue(paramType: TypeValue) extends TypeValue(ArrayTypeValue.CODENAME_TYPE)

src/main/scala/com/celadari/jsonlogicscala/tree/types/DefaultTypes.scala

@@ -1,5 +1,10 @@
+// Copyright 2019 celadari. All rights reserved. MIT license.
 package com.celadari.jsonlogicscala.tree.types
 
+
+/**
+ * Contains codename of default types.
+ */
 object DefaultTypes {
 
   val BYTE_CODENAME: String = "byte"

src/main/scala/com/celadari/jsonlogicscala/tree/types/MapTypeValue.scala

@@ -1,8 +1,12 @@
+// Copyright 2019 celadari. All rights reserved. MIT license.
 package com.celadari.jsonlogicscala.tree.types
 
 import play.api.libs.json.{JsValue, Writes}
 
 
+/**
+ * Companion object holding implicit writer json and constant codename for [[com.celadari.jsonlogicscala.tree.types.MapTypeValue]].
+ */
 object MapTypeValue {
   val CODENAME_TYPE: String = "map"
 
@@ -11,4 +15,9 @@ object MapTypeValue {
   }
 }
 
+/**
+ * Represents a Map[String, paramType] type.
+ * @param paramType: parameter type this map is of.
+ * @note inherited operator has fixed value of "map".
+ */
 case class MapTypeValue(paramType: TypeValue) extends TypeValue(MapTypeValue.CODENAME_TYPE)