JENA-813 : Add comments on usage. Project: http://git-wip-us.apache.org/repos/asf/jena/repo Commit: http://git-wip-us.apache.org/repos/asf/jena/commit/62ebeeea Tree: http://git-wip-us.apache.org/repos/asf/jena/tree/62ebeeea Diff: http://git-wip-us.apache.org/repos/asf/jena/diff/62ebeeea
Branch: refs/heads/master Commit: 62ebeeeaf7c2e8b69203c8cab12c69579b65d632 Parents: e455479 Author: Andy Seaborne <a...@apache.org> Authored: Tue Nov 11 10:20:11 2014 +0000 Committer: Andy Seaborne <a...@apache.org> Committed: Tue Nov 11 10:20:11 2014 +0000 ---------------------------------------------------------------------- .../src/main/java/org/apache/jena/atlas/iterator/Iter.java | 5 +++++ .../java/org/apache/jena/atlas/iterator/IteratorConcat.java | 8 +++++++- 2 files changed, 12 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/jena/blob/62ebeeea/jena-arq/src/main/java/org/apache/jena/atlas/iterator/Iter.java ---------------------------------------------------------------------- diff --git a/jena-arq/src/main/java/org/apache/jena/atlas/iterator/Iter.java b/jena-arq/src/main/java/org/apache/jena/atlas/iterator/Iter.java index 52352ea..d8f97fc 100644 --- a/jena-arq/src/main/java/org/apache/jena/atlas/iterator/Iter.java +++ b/jena-arq/src/main/java/org/apache/jena/atlas/iterator/Iter.java @@ -443,11 +443,16 @@ public class Iter<T> implements Iterable<T>, Iterator<T> { return Iter.operate(stream, action) ; } + /** See {@linkplain #append(Iterator, Iterator)} for scale considerations */ public static <T> Iterator<T> append(Iterable<T> iter1, Iterable<T> iter2) { return IteratorCons.create(iterator(iter1), iterator(iter2)) ; } // Could try for <? extends T> on each arg. + /** Join two iterators. + * If there potentially going to be many iterators, it is better to + * create an {@linkplain IteratorConcat} explicitly and add each iterator + */ public static <T> Iterator<T> append(Iterator<? extends T> iter1, Iterator<? extends T> iter2) { return IteratorCons.create(iter1, iter2) ; } http://git-wip-us.apache.org/repos/asf/jena/blob/62ebeeea/jena-arq/src/main/java/org/apache/jena/atlas/iterator/IteratorConcat.java ---------------------------------------------------------------------- diff --git a/jena-arq/src/main/java/org/apache/jena/atlas/iterator/IteratorConcat.java b/jena-arq/src/main/java/org/apache/jena/atlas/iterator/IteratorConcat.java index 34badf9..bc8bdfd 100644 --- a/jena-arq/src/main/java/org/apache/jena/atlas/iterator/IteratorConcat.java +++ b/jena-arq/src/main/java/org/apache/jena/atlas/iterator/IteratorConcat.java @@ -37,7 +37,13 @@ public class IteratorConcat<T> implements Iterator<T> private Iterator<T> removeFrom = null ; boolean finished = false ; - /** @see IteratorCons */ + /** + * Usually better to create an IteratorConcat explicitly and add iterator if theer are going to be many. + * @param iter1 + * @param iter2 + * @return Iterator + * @see IteratorCons + */ public static <T> Iterator<T> concat(Iterator<T> iter1, Iterator<T> iter2) { if (iter2 == null) return iter1 ;