Merge pull request #8 from relogiclabs/develop

Refactor and Optimize Source Code

Author: zhossain-info

doc/content/articles/quickstart.md

@@ -124,8 +124,8 @@ Here is the error as displayed in the console. More specific errors will be list
 Schema (Line: 6:31) Json (Line: 3:14) [DTYP04]: Data type mismatch. Data type #integer is expected but found #string inferred by "not number".
 Schema (Line: 6:14) Json (Line: 3:14) [FUNC03]: Function @range(1, 10000) is incompatible with the target data type. Applying to a supported data type such as #number is expected but applied to an unsupported data type #string of "not number".
 Schema (Line: 8:20) Json (Line: 4:20) [REGX01]: Regex pattern does not match. String of pattern "[a-z_]{3,30}" is expected but found "john doe" that mismatches with pattern.
-Schema (Line: 5:12) Json (Line: 2:12) [VALD01]: Validation failed. Value {"id": @range(1, 10000) #integer, "username": @regex("[a-z_]{3,30}") #string, "role": "user" #string, "isActive": #boolean, "register...ing, "country": @regex("[A-Za-z ]{3,50}") #string} #object #null}} is expected but found {"id": "not number", "username": "john doe", "role": "user", "isActive": true, "registeredAt": "2023-09-06T15:10:30.639Z", "profile":...: "123 Some St", "city": "Some town", "country": "Some Country"}}}.
-Schema (Line: 4:0) Json (Line: 1:0) [VALD01]: Validation failed. Value {"user": {"id": @range(1, 10000) #integer, "username": @regex("[a-z_]{3,30}") #string, "role": "user" #string, "isActive": #boolean, ...ng, "country": @regex("[A-Za-z ]{3,50}") #string} #object #null}}} is expected but found {"user": {"id": "not number", "username": "john doe", "role": "user", "isActive": true, "registeredAt": "2023-09-06T15:10:30.639Z", "... "123 Some St", "city": "Some town", "country": "Some Country"}}}}.
+Schema (Line: 5:12) Json (Line: 2:12) [VALD01]: Validation failed. A valid value of {"id": @range(1, 10000) #integer, "username": @regex("[a-z_]{3,30}") #string, "role": "user" #string, "isActive": #boolean, "register...ing, "country": @regex("[A-Za-z ]{3,50}") #string} #object #null}} is expected but found {"id": "not number", "username": "john doe", "role": "user", "isActive": true, "registeredAt": "2023-09-06T15:10:30.639Z", "profile":...: "123 Some St", "city": "Some town", "country": "Some Country"}}}.
+Schema (Line: 4:0) Json (Line: 1:0) [VALD01]: Validation failed. A valid value of {"user": {"id": @range(1, 10000) #integer, "username": @regex("[a-z_]{3,30}") #string, "role": "user" #string, "isActive": #boolean, ...ng, "country": @regex("[A-Za-z ]{3,50}") #string} #object #null}}} is expected but found {"user": {"id": "not number", "username": "john doe", "role": "user", "isActive": true, "registeredAt": "2023-09-06T15:10:30.639Z", "... "123 Some St", "city": "Some town", "country": "Some Country"}}}}.
 ```
 
 ## Assertion for Validation
@@ -148,13 +148,13 @@ Expected (Schema Line: 6:31): data type #integer
 Actual (Json Line: 3:14): found #string inferred by "not number"
 
 	at com.relogiclabs.json.schema.tree.ExceptionRegistry.failWith(ExceptionRegistry.java:31)
-	at com.relogiclabs.json.schema.type.JNode.failWith(JNode.java:75)
-	at com.relogiclabs.json.schema.type.JValidator.matchDataType(JValidator.java:89)
-	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:78)
+	at com.relogiclabs.json.schema.type.JNode.failWith(JNode.java:73)
+	at com.relogiclabs.json.schema.type.JValidator.matchDataType(JValidator.java:87)
+	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:76)
 	at com.relogiclabs.json.schema.type.JObject.match(JObject.java:57)
-	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:73)
+	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:71)
 	at com.relogiclabs.json.schema.type.JObject.match(JObject.java:57)
-	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:73)
+	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:71)
 	at com.relogiclabs.json.schema.type.JRoot.match(JRoot.java:50)
 	at com.relogiclabs.json.schema.tree.SchemaTree.match(SchemaTree.java:33)
 	at com.relogiclabs.json.schema.JsonAssert.isValid(JsonAssert.java:61)

doc/content/articles/sourcebuild.md

@@ -135,8 +135,8 @@ Here is the error as displayed in the console. More specific errors will be list
 Schema (Line: 6:31) Json (Line: 3:14) [DTYP04]: Data type mismatch. Data type #integer is expected but found #string inferred by "not number".
 Schema (Line: 6:14) Json (Line: 3:14) [FUNC03]: Function @range(1, 10000) is incompatible with the target data type. Applying to a supported data type such as #number is expected but applied to an unsupported data type #string of "not number".
 Schema (Line: 8:20) Json (Line: 4:20) [REGX01]: Regex pattern does not match. String of pattern "[a-z_]{3,30}" is expected but found "john doe" that mismatches with pattern.
-Schema (Line: 5:12) Json (Line: 2:12) [VALD01]: Validation failed. Value {"id": @range(1, 10000) #integer, "username": @regex("[a-z_]{3,30}") #string, "role": "user" #string, "isActive": #boolean, "register...ing, "country": @regex("[A-Za-z ]{3,50}") #string} #object #null}} is expected but found {"id": "not number", "username": "john doe", "role": "user", "isActive": true, "registeredAt": "2023-09-06T15:10:30.639Z", "profile":...: "123 Some St", "city": "Some town", "country": "Some Country"}}}.
-Schema (Line: 4:0) Json (Line: 1:0) [VALD01]: Validation failed. Value {"user": {"id": @range(1, 10000) #integer, "username": @regex("[a-z_]{3,30}") #string, "role": "user" #string, "isActive": #boolean, ...ng, "country": @regex("[A-Za-z ]{3,50}") #string} #object #null}}} is expected but found {"user": {"id": "not number", "username": "john doe", "role": "user", "isActive": true, "registeredAt": "2023-09-06T15:10:30.639Z", "... "123 Some St", "city": "Some town", "country": "Some Country"}}}}.
+Schema (Line: 5:12) Json (Line: 2:12) [VALD01]: Validation failed. A valid value of {"id": @range(1, 10000) #integer, "username": @regex("[a-z_]{3,30}") #string, "role": "user" #string, "isActive": #boolean, "register...ing, "country": @regex("[A-Za-z ]{3,50}") #string} #object #null}} is expected but found {"id": "not number", "username": "john doe", "role": "user", "isActive": true, "registeredAt": "2023-09-06T15:10:30.639Z", "profile":...: "123 Some St", "city": "Some town", "country": "Some Country"}}}.
+Schema (Line: 4:0) Json (Line: 1:0) [VALD01]: Validation failed. A valid value of {"user": {"id": @range(1, 10000) #integer, "username": @regex("[a-z_]{3,30}") #string, "role": "user" #string, "isActive": #boolean, ...ng, "country": @regex("[A-Za-z ]{3,50}") #string} #object #null}}} is expected but found {"user": {"id": "not number", "username": "john doe", "role": "user", "isActive": true, "registeredAt": "2023-09-06T15:10:30.639Z", "... "123 Some St", "city": "Some town", "country": "Some Country"}}}}.
 ```
 
 ## Assertion for Validation
@@ -159,13 +159,13 @@ Expected (Schema Line: 6:31): data type #integer
 Actual (Json Line: 3:14): found #string inferred by "not number"
 
 	at com.relogiclabs.json.schema.tree.ExceptionRegistry.failWith(ExceptionRegistry.java:31)
-	at com.relogiclabs.json.schema.type.JNode.failWith(JNode.java:75)
-	at com.relogiclabs.json.schema.type.JValidator.matchDataType(JValidator.java:89)
-	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:78)
+	at com.relogiclabs.json.schema.type.JNode.failWith(JNode.java:73)
+	at com.relogiclabs.json.schema.type.JValidator.matchDataType(JValidator.java:87)
+	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:76)
 	at com.relogiclabs.json.schema.type.JObject.match(JObject.java:57)
-	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:73)
+	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:71)
 	at com.relogiclabs.json.schema.type.JObject.match(JObject.java:57)
-	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:73)
+	at com.relogiclabs.json.schema.type.JValidator.match(JValidator.java:71)
 	at com.relogiclabs.json.schema.type.JRoot.match(JRoot.java:50)
 	at com.relogiclabs.json.schema.tree.SchemaTree.match(SchemaTree.java:33)
 	at com.relogiclabs.json.schema.JsonAssert.isValid(JsonAssert.java:61)

doc/content/articles/validation.md

@@ -37,7 +37,7 @@ A JSON Schema ensures the correctness and consistency of JSON documents, and it
 | 11 | `Undefined`                                             | `!`                                                      |
 | 12 | `Undefined Optional`                                    | `! ?`                                                    |
 
-The syntax used in the 9th row of the table is valid, but not common in real-world scenarios. The constraint function and data type provide redundant validations, considering the validation for value is succeeded. It is generally recommended to specify the data type in all cases except in the previous scenario. Even though the functions may perform precise validations, they are typically designed to accept a broader range of data types. Therefore, specifying the data type not only makes the schema more unambiguous for readers, but also generates clear validation errors if the expected type of value is not received from the input document. For instance, the `@range` function is defined for all types of numeric input as well as dates and times. If you only accept integers for a particular field, the `@range` function without `#integer` data type cannot ensure this requirement.
+The syntax used in the 10th row of the table is valid, but not common in real-world scenarios. The constraint function and data type provide redundant validations, considering the validation for value is succeeded. It is generally recommended to specify the data type in all cases except in the previous scenario. Even though the functions may perform precise validations, they are typically designed to accept a broader range of data types. Therefore, specifying the data type not only makes the schema more unambiguous for readers, but also generates clear validation errors if the expected type of value is not received from the input document. For instance, the `@range` function is defined for all types of numeric input as well as dates and times. If you only accept integers for a particular field, the `@range` function without `#integer` data type cannot ensure this requirement.
 
 Now, let's explore the components of this notation and their functionalities. In the context of the validation rule, `Value` refers to a specific input JSON value of the document. This value can be either a composite value (e.g., an object or an array) or a primitive value (e.g., a string or a number).
 

doc/public/api/allclasses-index.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>All Classes and Interfaces (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>All Classes and Interfaces (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

doc/public/api/allpackages-index.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>All Packages (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>All Packages (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/json/schema/JsonAssert.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>JsonAssert (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>JsonAssert (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="declaration: package: com.relogiclabs.json.schema, class: JsonAssert">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/json/schema/JsonSchema.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>JsonSchema (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>JsonSchema (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="declaration: package: com.relogiclabs.json.schema, class: JsonSchema">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/json/schema/class-use/JsonAssert.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>Uses of Class com.relogiclabs.json.schema.JsonAssert (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>Uses of Class com.relogiclabs.json.schema.JsonAssert (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="use: package: com.relogiclabs.json.schema, class: JsonAssert">
 <meta name="generator" content="javadoc/ClassUseWriter">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/json/schema/class-use/JsonSchema.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>Uses of Class com.relogiclabs.json.schema.JsonSchema (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>Uses of Class com.relogiclabs.json.schema.JsonSchema (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="use: package: com.relogiclabs.json.schema, class: JsonSchema">
 <meta name="generator" content="javadoc/ClassUseWriter">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/json/schema/collection/IndexMap.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>IndexMap (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>IndexMap (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="declaration: package: com.relogiclabs.json.schema.collection, interface: IndexMap">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/json/schema/collection/Keyable.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>Keyable (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>Keyable (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="declaration: package: com.relogiclabs.json.schema.collection, interface: Keyable">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/json/schema/collection/class-use/IndexMap.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>Uses of Interface com.relogiclabs.json.schema.collection.IndexMap (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>Uses of Interface com.relogiclabs.json.schema.collection.IndexMap (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="use: package: com.relogiclabs.json.schema.collection, interface: IndexMap">
 <meta name="generator" content="javadoc/ClassUseWriter">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/json/schema/collection/class-use/Keyable.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>Uses of Interface com.relogiclabs.json.schema.collection.Keyable (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>Uses of Interface com.relogiclabs.json.schema.collection.Keyable (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="use: package: com.relogiclabs.json.schema.collection, interface: Keyable">
 <meta name="generator" content="javadoc/ClassUseWriter">
 <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">

doc/public/api/com/relogiclabs/json/schema/collection/package-summary.html

@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang="en">
 <head>
-<!-- Generated by javadoc (17) on Fri Dec 15 18:08:25 BDT 2023 -->
-<title>com.relogiclabs.json.schema.collection (New Json Schema 1.11.0 API)</title>
+<!-- Generated by javadoc (17) on Thu Dec 21 19:43:29 BDT 2023 -->
+<title>com.relogiclabs.json.schema.collection (New Json Schema 1.12.0 API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="dc.created" content="2023-12-15">
+<meta name="dc.created" content="2023-12-21">
 <meta name="description" content="declaration: package: com.relogiclabs.json.schema.collection">
 <meta name="generator" content="javadoc/PackageWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">