From 3ea1b2ba9ae3aede0a27129bddbc9eb73b5789de Mon Sep 17 00:00:00 2001 From: Otavio Santana Date: Sat, 2 Mar 2024 07:12:06 +0000 Subject: [PATCH] docs: update documentation Signed-off-by: Otavio Santana --- .../src/main/java/module-info.java | 7 ++++--- .../communication/semistructured/CriteriaCondition.java | 7 +++++++ .../jnosql/communication/semistructured/DeleteQuery.java | 3 +++ .../communication/semistructured/DeleteQueryParams.java | 2 ++ .../communication/semistructured/DeleteQueryParser.java | 4 ++++ .../jnosql/communication/semistructured/QueryParams.java | 2 ++ .../communication/semistructured/SelectQueryParser.java | 3 +++ 7 files changed, 25 insertions(+), 3 deletions(-) diff --git a/jnosql-communication/jnosql-communication-semistructured/src/main/java/module-info.java b/jnosql-communication/jnosql-communication-semistructured/src/main/java/module-info.java index 465cd3985..3b7a1f047 100644 --- a/jnosql-communication/jnosql-communication-semistructured/src/main/java/module-info.java +++ b/jnosql-communication/jnosql-communication-semistructured/src/main/java/module-info.java @@ -10,14 +10,15 @@ * Contributors: * Otavio Santana */ -module org.eclipse.jnosql.communication.column { +/** + * This module contains the communication layer to work with semi-structured databases. + */ +module org.eclipse.jnosql.communication.semistructured { uses org.eclipse.jnosql.communication.semistructured.DatabaseConfiguration; requires org.eclipse.jnosql.communication.core; requires org.eclipse.jnosql.communication.query; requires jakarta.json.bind; requires jakarta.json; requires jakarta.data; - opens org.eclipse.jnosql.communication.semistructured; - } \ No newline at end of file diff --git a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/CriteriaCondition.java b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/CriteriaCondition.java index 83ce29615..a38592a5b 100644 --- a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/CriteriaCondition.java +++ b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/CriteriaCondition.java @@ -156,6 +156,13 @@ public String toString() { '}'; } + /** + * Creates a new {@link CriteriaCondition} with the same element and condition, but with the read-only flag set to true. + * + * @param condition the condition to be marked as read-only + * @return a new read-only condition + * @throws NullPointerException when the condition is null + */ public static CriteriaCondition readOnly(CriteriaCondition condition) { Objects.requireNonNull(condition, "Condition is required"); return new CriteriaCondition(condition.element(), condition.condition(), true); diff --git a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQuery.java b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQuery.java index a7287d76c..a1af516c6 100644 --- a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQuery.java +++ b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQuery.java @@ -125,6 +125,9 @@ interface EntityDelete { interface DeleteProvider extends Function, Supplier { } + /** + * The initial element in the Column delete query. + */ interface DeleteQueryBuilderProvider extends Function, Supplier { diff --git a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParams.java b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParams.java index 49f3b2ed5..6686e93e3 100644 --- a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParams.java +++ b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParams.java @@ -16,6 +16,8 @@ /** * The result of {@link DeleteQueryParams} that has {@link DeleteQuery} and {@link Params}. + * @param query the {@link DeleteQuery} + * @param params the {@link Params} */ public record DeleteQueryParams(DeleteQuery query, Params params) { diff --git a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParser.java b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParser.java index 4d3037005..1afbeb94f 100644 --- a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParser.java +++ b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/DeleteQueryParser.java @@ -22,6 +22,10 @@ import static java.util.Objects.requireNonNull; +/** + * The {@link DeleteQueryParser} has the logic to convert from {@link org.eclipse.jnosql.communication.query.DeleteQuery} + * to {@link DeleteQueryParams}. + */ public final class DeleteQueryParser implements BiFunction { diff --git a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/QueryParams.java b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/QueryParams.java index 956fd2921..995e13b9c 100644 --- a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/QueryParams.java +++ b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/QueryParams.java @@ -16,6 +16,8 @@ /** * The result of {@link org.eclipse.jnosql.communication.query.SelectQueryConverter} that has {@link SelectQuery} and {@link Params}. + * @param query the {@link SelectQuery} + * @param params the {@link Params} */ public record QueryParams(SelectQuery query, Params params) { diff --git a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/SelectQueryParser.java b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/SelectQueryParser.java index a3e14bffc..488e0a87a 100644 --- a/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/SelectQueryParser.java +++ b/jnosql-communication/jnosql-communication-semistructured/src/main/java/org/eclipse/jnosql/communication/semistructured/SelectQueryParser.java @@ -28,6 +28,9 @@ public final class SelectQueryParser implements BiFunction { + /** + * The default constructor + */ public SelectQueryParser() { }