You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by aa...@apache.org on 2026/09/13 14:37:19 UTC

(cayenne) 01/03: clarifying Javadocs

This is an automated email from the ASF dual-hosted git repository.

asf-gitbox-commits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cayenne.git

commit dbc654c4ddb26ec3e3dd41ff79109131fd40191c
Author: Andrus Adamchik <an...@objectstyle.com>
AuthorDate: Sun Sep 13 10:17:09 2026 -0400

    clarifying Javadocs
---
 cayenne/src/main/java/org/apache/cayenne/QueryResult.java | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/cayenne/src/main/java/org/apache/cayenne/QueryResult.java b/cayenne/src/main/java/org/apache/cayenne/QueryResult.java
index 561826e6d..431970086 100644
--- a/cayenne/src/main/java/org/apache/cayenne/QueryResult.java
+++ b/cayenne/src/main/java/org/apache/cayenne/QueryResult.java
@@ -18,16 +18,16 @@
  ****************************************************************/
 package org.apache.cayenne;
 
+import org.apache.cayenne.query.Query;
+
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 
 /**
- * A single item of a multipart query result, as returned by {@code SQLExec.execute(..)},
- * {@code MappedExec.execute(..)} and {@code ProcedureCall.call(..)}: a list of selected objects, update counts, an
- * open result iterator, or the OUT parameters of a stored procedure. Items are listed in the order they were
- * produced, so callers that know the shape of their query can access them by index. The hierarchy is sealed, so
- * callers can exhaustively switch over the item type:
+ * A single item of a multipart query result. QueryResults are returned as a list from {@link ObjectContext#execute(Query)}.
+ * The goal is to expose a specific combination of ResultSets, update counts and procedure OUT parameters produced by a
+ * JDBC statement. The user can process each QueryResult like this:
  * <pre>{@code
  * for (QueryResult item : SQLExec.query(sql).execute(context)) {
  *     switch (item) {