Github user joshelser commented on a diff in the pull request:
https://github.com/apache/accumulo/pull/159#discussion_r108462721
--- Diff: docs/src/main/asciidoc/chapters/iterator_design.txt ---
@@ -182,6 +182,12 @@ early programming assignments which implement their
own tree data structures. `d
copy on its sources (the children), copies itself, attaches the copies of
the children, and
then returns itself.
+==== `close`
+
+This method should close any resources created by the iterator. In
particular, this method should call `close`
+on the `source` provided by the first argument of the `init` method. By
default this method will do nothing.
--- End diff --
Maybe expand this to also specifically call out SKVI's which are created
via deepCopy? Something like: ".. of the `init` method[ as well as any other
Iterators created via invoking `deepCopy()`]"? Phrasing could use work :)
What about the guarantees on `close()` being called? I re-read Dylan's
earlier comment -- something like "`close()` will be invoked in all scenarios
except those resulting in JVM failure such as an `OutOfMemoryError`"?
---
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 [email protected] or file a JIRA ticket
with INFRA.
---
