docs: include javadoc documentation when there is no support

Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
jakartaee · Apr 29, 2023 · be52dd3 · be52dd3
1 parent b5d65a5
commit be52dd3
Showing 1 changed file with 15 additions and 11 deletions.
diff --git a/api/nosql-core/src/main/java/jakarta/nosql/Template.java b/api/nosql-core/src/main/java/jakarta/nosql/Template.java
@@ -20,7 +20,7 @@
 
 /**
  * Templates are a helper class that increases productivity when performing common NoSQL operations.
- *  The Template feature in Jakarta NoSQL simplifies the implementation of common database
+ * The Template feature in Jakarta NoSQL simplifies the implementation of common database
  * operations by providing a basic API to the underlying persistence engine.
  * It follows the standard template pattern, a common design pattern used in software development.
  */
@@ -98,9 +98,9 @@ public interface Template {
      * Finds by Id.
      *
      * @param type the entity class
-     * @param id          the id value
-     * @param <T>         the entity class type
-     * @param <K>         the id type
+     * @param id   the id value
+     * @param <T>  the entity class type
+     * @param <K>  the id type
      * @return the entity instance otherwise {@link Optional#empty()}
      * @throws NullPointerException when either the type or id are null
      */
@@ -110,9 +110,9 @@ public interface Template {
      * Deletes by Id.
      *
      * @param type the entity class
-     * @param id          the id value
-     * @param <T>         the entity class type
-     * @param <K>         the id type
+     * @param id   the id value
+     * @param <T>  the entity class type
+     * @param <K>  the id type
      * @throws NullPointerException when either the type or id are null
      */
     <T, K> void delete(Class<T> type, K id);
@@ -121,19 +121,23 @@ public interface Template {
      * It starts a query using the fluent-API journey. It is a mutable and non-thread-safe instance.
      *
      * @param type the entity class
-     * @param <T>         the entity type
+     * @param <T>  the entity type
      * @return a {@link QueryMapper.MapperFrom} instance
-     * @throws NullPointerException when type is null
+     * @throws NullPointerException          when type is null
+     * @throws UnsupportedOperationException when the database cannot operate,
+     *                                       such as key-value where most operations are key-based.
      */
     <T> QueryMapper.MapperFrom select(Class<T> type);
 
     /**
      * It starts a query using the fluent-API journey. It is a mutable and non-thread-safe instance.
      *
      * @param type the entity class
-     * @param <T>         the entity type
+     * @param <T>  the entity type
      * @return a {@link QueryMapper.MapperDeleteFrom} instance
-     * @throws NullPointerException when type is null
+     * @throws NullPointerException          when type is null
+     * @throws UnsupportedOperationException when the database cannot operate,
+     *                                       such as key-value where most operations are key-based.
      */
     <T> QueryMapper.MapperDeleteFrom delete(Class<T> type);
 }