Skip to content

Commit e4278c2

Browse files
committed
update expectations about failure listeners in javadoc
1 parent 3bb0133 commit e4278c2

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

src/main/java/com/marklogic/client/datamovement/QueryBatcher.java

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -120,9 +120,14 @@ public interface QueryBatcher extends Batcher {
120120
QueryBatcher onUrisReady(QueryBatchListener listener);
121121

122122
/**
123-
* Add a listener to run each time there is an Exception retrieving a batch
124-
* of uris or running a listener registered with onUrisReady.
125-
* @param listener the action which has to be done when the query fails
123+
* Add a listener to run each time there is an exception retrieving a batch
124+
* of uris.
125+
*
126+
* These listeners will not run when an exception is thrown by a listener
127+
* registered with onUrisReady. To learn more, please see
128+
* [Handling Exceptions in Listeners](package-summary.html#errs)
129+
*
130+
* @param listener the code to run when a failure occurs
126131
* @return this instance for method chaining
127132
*/
128133
QueryBatcher onQueryFailure(QueryFailureListener listener);

src/main/java/com/marklogic/client/datamovement/WriteBatcher.java

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,13 @@ WriteBatcher addAs(String uri, DocumentMetadataWriteHandle metadataHandle,
138138
WriteBatcher onBatchSuccess(WriteBatchListener listener);
139139

140140
/**
141-
* Add a listener to run each time there is an Exception writing a batch
142-
* or running a listener registered with onBatchSuccess.
143-
* @param listener the action which has to be done when the batch gets failed
141+
* Add a listener to run each time there is an exception writing a batch.
142+
*
143+
* These listeners will not run when an exception is thrown by a listener
144+
* registered with onBatchSuccess. To learn more, please see
145+
* [Handling Exceptions in Listeners](package-summary.html#errs)
146+
*
147+
* @param listener the code to run when a failure occurs
144148
* @return this instance for method chaining
145149
*/
146150
WriteBatcher onBatchFailure(WriteFailureListener listener);

0 commit comments

Comments
 (0)