Github user joshelser commented on a diff in the pull request:
https://github.com/apache/accumulo/pull/260#discussion_r119900221
--- Diff:
core/src/main/java/org/apache/accumulo/core/iterators/SortedKeyValueIterator.java
---
@@ -147,4 +147,16 @@
* if not supported.
*/
SortedKeyValueIterator<K,V> deepCopy(IteratorEnvironment env);
+
+ /**
+ * Called when the client (i.e. calling iterator or the tserver) will
support this iterators ability to yield. If called, then when next or seek is
called
--- End diff --
Javadoc is best written in third-person, declarative (and should avoid
using they word to describe the word being defined), e.g. "Allows
implementations to preempt further iteration of this iterator in the current
RPC. Implementations can use the `yield` method on the `callback` to instruct
the caller to cease collecting more results. The yield method accepts a `Key`
which is a hint to the caller to resume the scan without returning more data;
that is, the `Key` set should be the last Key processed by this Iterator,
either internally or externally that would safely enable this iterator to not
return duplicate data or omit data. This feature is not supported for isolated
scans. Most iterators do not need to implement this method."
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
