Github user ajs6f commented on a diff in the pull request:
https://github.com/apache/jena/pull/90#discussion_r35871940
--- Diff: jena-base/src/main/java/org/apache/jena/atlas/iterator/Iter.java
---
@@ -29,6 +29,14 @@
import org.apache.jena.atlas.lib.Closeable ;
import org.apache.jena.atlas.lib.Sink ;
+/**
+ * Iter provides utilities for working with {@link Iterator}s.
+ *
+ * Iter should never be used as a return type or parameter type in the
public contract of a class. It is only to be used
+ * inside implementation code and is instantiated only to allow
method-chaining as part of a calculation.
--- End diff --
This is exactly what I needed. Sorry to have bugged you so much about it,
but I really think this deserves to be written down. I will correct this PR to
advise just what you just did.
I am a little surprised that Jena's policy is that once a type is exposed,
it can never be changed. That seems extraordinarily restrictive. But that's a
completely different question.
---
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.
---
