Add documentation

ezylang · Jun 26, 2024 · 4c4a8b6 · 4c4a8b6
1 parent 9b2bd22
commit 4c4a8b6
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 3 deletions.
diff --git a/docs/concepts/datatypes.md b/docs/concepts/datatypes.md
@@ -19,8 +19,11 @@ EvalEx supports the following data types:
 | ARRAY           | java.util.List                    |
 | STRUCTURE       | java.util.Map                     |
 | EXPRESSION_NODE | com.ezylang.evalex.parser.ASTNode |
+| BINARY[^1]      | java.lang.Object                  |
 | NULL            | null                              |
 
+[^1]: Since 3.3.0
+
 Data is stored in an _EvaluationValue_, which holds the value and the data type.
 
 ### NUMBER
@@ -214,6 +217,18 @@ Note that the above expression is not evaluated as "2 * 4 + 3", which would resu
 Instead, the sub-expression "4 + 3" is calculated first, when it comes to finding the value of the
 variable _b_. Resulting in calculation of "2 * 7", which is 14.
 
+
+### BINARY
+
+A representation for an undefined (raw), non-null object that could not fit in any of the previous
+data types.
+
+This allows for special functions to handle any object type.
+
+The binary data type is **disabled** by default and can be enabled by setting a dedicated property
+in the [Configuration](../configuration/configuration.html).
+
+
 ### NULL
 
 A representation for _null_ objects.

diff --git a/docs/concepts/parsing_evaluation.md b/docs/concepts/parsing_evaluation.md
@@ -56,8 +56,11 @@ _EvaluationValue_ will be of one of the types:
 - NUMBER - If the expression resulted in a number.
 - STRING - If the expression resulted in a string.
 - BOOLEAN - If the expression resulted in a boolean value.
+- DATE_TIME - If the expression resulted in a date/time value.
+- DURATION - If the expression resulted in a duration value.
 - ARRAY - If the expression resulted in an array.
 - STRUCTURE - If the expression resulted in a structure.
+- BINARY - If the expression could not be converted to any of the previous types.
 
 The _EvaluationValue_ has methods to check and retrieve/convert the evaluation value.
 

diff --git a/docs/configuration/configuration.md b/docs/configuration/configuration.md
@@ -27,6 +27,7 @@ ExpressionConfiguration configuration=ExpressionConfiguration.builder()
         .powerOfPrecedence(OperatorIfc.OPERATOR_PRECEDENCE_POWER)
         .stripTrailingZeros(true)
         .structuresAllowed(true)
+        .binaryAllowed(false)
         .singleQuoteStringLiteralsAllowed(false)
         .zoneId(ZoneId.systemDefault())
         .build();
@@ -45,6 +46,15 @@ Specifies if the array index function is allowed (default is true). If set to fa
 will throw a _ParseException_, if there is a '[' is encountered in the expression and also no
 operator or function is defined for this character.
 
+### Binary allowed
+
+Specifies if the binary[^1] (raw) data type is allowed for expressions that can not be converted to any
+known data type. 
+
+See chapter [Data Types](../concepts/datatypes.html) for details.
+
+[^1]: Since 3.3.0
+
 ### Data Accessor
 
 The Data Accessor is responsible for storing and retrieving variable values.

diff --git a/src/main/java/com/ezylang/evalex/config/ExpressionConfiguration.java b/src/main/java/com/ezylang/evalex/config/ExpressionConfiguration.java
@@ -224,7 +224,7 @@ public class ExpressionConfiguration {
   @Builder.Default private final boolean structuresAllowed = true;
 
   /**
-   * Support for the BINARY (undefined) data type is allowed or not.
+   * Support for the binary (undefined) data type is allowed or not.
    *
    * @since 3.3.0
    */

diff --git a/src/main/java/com/ezylang/evalex/data/EvaluationValue.java b/src/main/java/com/ezylang/evalex/data/EvaluationValue.java
@@ -80,7 +80,7 @@ public enum DataType {
     EXPRESSION_NODE,
     /** A null value */
     NULL,
-    /** Undefined type, stored as an {@link Object}. */
+    /** Raw (undefined) type, stored as an {@link Object}. */
     BINARY
   }
 
@@ -222,7 +222,7 @@ public static EvaluationValue structureValue(Map<?, ?> value) {
   }
 
   /**
-   * Creates a new binary value.
+   * Creates a new binary (raw) value.
    *
    * @param value The Object to use.
    * @return the new binary value.