docs: enhance ColumnTemplate javadoc

Signed-off-by: Maximillian Arruda <dearrudam@gmail.com>
jakartaee · Jun 12, 2023 · 5bce932 · 5bce932
1 parent 1235f62
commit 5bce932
Showing 1 changed file with 16 additions and 4 deletions.
diff --git a/api/nosql-column/src/main/java/jakarta/nosql/column/ColumnTemplate.java b/api/nosql-column/src/main/java/jakarta/nosql/column/ColumnTemplate.java
@@ -23,11 +23,14 @@
 import java.util.stream.Stream;
 
 /**
- * The <b>ColumnTemplate</b> class is a type of <b>Template</b> that makes it easier to work with Column-Family
- * or Wide-Column databases. These NoSQL databases store data in a table-like structure,
+ * It's a {@link Template} specialization for Column-Family or Wide-Column databases.
+ *
+ * <p>
+ * These NoSQL databases store data in a table-like structure,
  * where each column contains a particular attribute or piece of information.
- * The query syntax belongs to each provider; thus, it is not Jakarta's NoSQL scope to define it.
- * Accordingly, it might vary from implementation and NoSQL provider.
+ *
+ * <p>
+ * This interface provides some methods that accepts queries in a text format to retrieve from the database but, <b>the query syntax belongs to each provider, thus, it is not Jakarta's NoSQL scope to define it. Accordingly, it might vary from implementation and NoSQL provider.</b>
  */
 public interface ColumnTemplate extends Template {
 
@@ -56,6 +59,9 @@ public interface ColumnTemplate extends Template {
     /**
      * Executes a native query database then bring the result as a {@link Stream}
      *
+     * <p>
+     * <b>the query syntax belongs to each provider, thus, it is not Jakarta's NoSQL scope to define it. Accordingly, it might vary from implementation and NoSQL provider.</b>
+     *
      * @param query the query
      * @param <T>   the entity type
      * @return the result as {@link Stream}
@@ -67,6 +73,9 @@ public interface ColumnTemplate extends Template {
     /**
      * Executes a query then bring the result as a unique result
      *
+     * <p>
+     * <b>the query syntax belongs to each provider, thus, it is not Jakarta's NoSQL scope to define it. Accordingly, it might vary from implementation and NoSQL provider.</b>
+     *
      * @param query the query
      * @param <T>   the entity type
      * @return the result as {@link Optional}
@@ -78,6 +87,9 @@ public interface ColumnTemplate extends Template {
     /**
      * Creates a {@link PreparedStatement} from the query
      *
+     * <p>
+     * <b>the query syntax belongs to each provider, thus, it is not Jakarta's NoSQL scope to define it. Accordingly, it might vary from implementation and NoSQL provider.</b>
+     *
      * @param query the query
      * @return a {@link PreparedStatement} instance
      * @throws NullPointerException          when the query is null