docs: update UnsupportedOperationException at QueryMapper

Signed-off-by: Otavio Santana <otaviopolianasantana@gmail.com>
jakartaee · Feb 23, 2024 · a3d9c39 · a3d9c39
1 parent 499f944
commit a3d9c39
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/api/src/main/java/jakarta/nosql/QueryMapper.java b/api/src/main/java/jakarta/nosql/QueryMapper.java
@@ -158,6 +158,10 @@ interface MapperDeleteQueryBuild {
 
         /**
          * Executes the query.
+         * @throws UnsupportedOperationException If a NoSQL database does not support a specific operation or if the
+         *                                       database does not support certain query conditions, an exception will be raised. For example, a wide-column
+         *                                       may not support the OR operator, or a document database may not support the BETWEEN operator.
+         *                                       The level of NoSQL database support for various conditions may vary depending on the database provider.
          */
         void execute();
 
@@ -412,6 +416,10 @@ interface MapperQueryBuild {
          *
          * @param <T> the entity type
          * @return the result of the query
+         * @throws UnsupportedOperationException If a NoSQL database does not support a specific operation or if the
+         *                                       database does not support certain query conditions, an exception will be raised. For example, a wide-column
+         *                                       may not support the OR operator, or a document database may not support the BETWEEN operator.
+         *                                       The level of NoSQL database support for various conditions may vary depending on the database provider.
          */
         <T> List<T> result();
 
@@ -420,6 +428,10 @@ interface MapperQueryBuild {
          *
          * @param <T> the entity type
          * @return the result of the query
+         * @throws UnsupportedOperationException If a NoSQL database does not support a specific operation or if the
+         *                                       database does not support certain query conditions, an exception will be raised. For example, a wide-column
+         *                                       may not support the OR operator, or a document database may not support the BETWEEN operator.
+         *                                       The level of NoSQL database support for various conditions may vary depending on the database provider.
          */
         <T> Stream<T> stream();
 
@@ -434,6 +446,10 @@ interface MapperQueryBuild {
          *
          * @param <T> the type of the entity being queried
          * @return an Optional containing the single result of the query, if present, or empty if no result is found
+         * @throws UnsupportedOperationException If a NoSQL database does not support a specific operation or if the
+         *                                       database does not support certain query conditions, an exception will be raised. For example, a wide-column
+         *                                       may not support the OR operator, or a document database may not support the BETWEEN operator.
+         *                                       The level of NoSQL database support for various conditions may vary depending on the database provider.
          */
         <T> Optional<T> singleResult();