[GH] Clarify javadoc of Query.cancel() and cancelAll() (db-jdo)

["clr-apache (via GitHub)" <gi...@apache.org>]

clr-apache commented on code in PR #92:
URL: https://github.com/apache/db-jdo/pull/92#discussion_r1501692446


##########
api/src/main/java/javax/jdo/Query.java:
##########
@@ -759,18 +759,19 @@ void addSubquery(
   Integer getDatastoreWriteTimeoutMillis();
 
   /**
-   * Method to cancel any executing queries. If the underlying datastore doesn't support
-   * cancellation of queries this will throw JDOUnsupportedOptionException. If the cancellation
-   * fails (e.g in the underlying datastore) then this will throw a JDOException.
+   * Method to cancel all executions of this query instance. If the underlying datastore doesn't
+   * support cancellation of queries this will throw JDOUnsupportedOptionException. If the
+   * cancellation fails (e.g in the underlying datastore) then this will throw a JDOException.
    *
    * @since 3.0
    */
   void cancelAll();
 
   /**
-   * Method to cancel an executing query in the specified thread. If the underlying datastore
-   * doesn't support cancellation of queries this will throw JDOUnsupportedOptionException. If the
-   * cancellation fails (e.g in the underlying datastore) then this will throw a JDOException.
+   * Method to cancel any executions of this query instance that run in the specified thread. If the
+   * underlying datastore doesn't support cancellation of queries this will throw
+   * JDOUnsupportedOptionException. If the cancellation fails (e.g in the underlying datastore) then
+   * this will throw a JDOException.
    *
    * @param thread The thread to cancel

Review Comment:
   I believe that there is no way for a single thread to have multiple simultaneous executions of a query. So there is no reason to change the text of the javadoc for cancelAll. 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: jdo-dev-unsubscribe@db.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org