Return-Path: X-Original-To: apmail-commons-commits-archive@minotaur.apache.org Delivered-To: apmail-commons-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 7D448E123 for ; Sat, 15 Dec 2012 23:45:02 +0000 (UTC) Received: (qmail 88327 invoked by uid 500); 15 Dec 2012 23:45:02 -0000 Delivered-To: apmail-commons-commits-archive@commons.apache.org Received: (qmail 88260 invoked by uid 500); 15 Dec 2012 23:45:02 -0000 Mailing-List: contact commits-help@commons.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@commons.apache.org Delivered-To: mailing list commits@commons.apache.org Received: (qmail 88253 invoked by uid 99); 15 Dec 2012 23:45:01 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 15 Dec 2012 23:45:01 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sat, 15 Dec 2012 23:44:57 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 16AF92388CAA; Sat, 15 Dec 2012 23:43:41 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1422422 [26/33] - in /commons/cms-site/trunk/collections/api-2.1.1: ./ org/ org/apache/ org/apache/commons/ org/apache/commons/collections/ org/apache/commons/collections/class-use/ org/apache/commons/collections/comparators/ org/apache/co... Date: Sat, 15 Dec 2012 23:43:19 -0000 To: commits@commons.apache.org From: olamy@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20121215234341.16AF92388CAA@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/CollatingIterator.html URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/CollatingIterator.html?rev=1422422&view=auto ============================================================================== --- commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/CollatingIterator.html (added) +++ commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/CollatingIterator.html Sat Dec 15 23:43:02 2012 @@ -0,0 +1,586 @@ + + + + + + +CollatingIterator (Collections 2.1.1 release API) + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.commons.collections.iterators +
+Class CollatingIterator

+
+java.lang.Object
+  |
+  +--org.apache.commons.collections.iterators.CollatingIterator
+
+
+
All Implemented Interfaces:
java.util.Iterator
+
+
+
+
public class CollatingIterator
extends java.lang.Object
implements java.util.Iterator
+ +

+Provides an ordered iteration over the elements contained in + a collection of ordered Iterators. In other words, + given two ordered Iterators A and B, + my next() method will return the lesser of + A.next() and B.next(). +

+ +

+

+
Since:
+
2.1
+
Version:
+
$Revision: 1.3.2.1 $ $Date: 2004/05/22 12:14:04 $
+
Author:
+
Rodney Waldhoff, Stephen Colebourne
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
CollatingIterator() + +
+          Constructs a new CollatingIterator.
CollatingIterator(java.util.Comparator comp) + +
+          Constructs a new CollatingIterator that will used the + specified comparator for ordering.
CollatingIterator(java.util.Comparator comp, + java.util.Collection iterators) + +
+          Constructs a new CollatingIterator that will use the + specified comparator to provide ordered iteration over the collection + of iterators.
CollatingIterator(java.util.Comparator comp, + int initIterCapacity) + +
+          Constructs a new CollatingIterator that will used the + specified comparator for ordering and have the specified initial + capacity.
CollatingIterator(java.util.Comparator comp, + java.util.Iterator[] iterators) + +
+          Constructs a new CollatingIterator that will use the + specified comparator to provide ordered iteration over the array + of iterators.
CollatingIterator(java.util.Comparator comp, + java.util.Iterator a, + java.util.Iterator b) + +
+          Constructs a new CollatingIterator that will use the + specified comparator to provide ordered iteration over the two + given iterators.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidaddIterator(java.util.Iterator iterator) + +
+          Add the given Iterator to my collection to collate.
+ java.util.ComparatorgetComparator() + +
+          Get the Comparator by which I collate.
+ java.util.ListgetIterators() + +
+          Get the list of Iterators (unmodifiable)
+ booleanhasNext() + +
+          Returns true if any child iterator has remaining elements.
+ java.lang.Objectnext() + +
+          Returns the next ordered element from a child iterator.
+ voidremove() + +
+          Removes the last returned element from the child iterator that + produced it.
+ voidsetComparator(java.util.Comparator comp) + +
+          Set the Comparator by which I collate.
+ voidsetIterator(int index, + java.util.Iterator iterator) + +
+          Set the Iterator at the given index
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+CollatingIterator

+
+public CollatingIterator()
+
+
Constructs a new CollatingIterator. Natural sort order + will be used, and child iterators will have to be manually added + using the addIterator(Iterator) method. +

+

+
+ +

+CollatingIterator

+
+public CollatingIterator(java.util.Comparator comp)
+
+
Constructs a new CollatingIterator that will used the + specified comparator for ordering. Child iterators will have to be + manually added using the addIterator(Iterator) method. +

+

Parameters:
comp - the comparator to use for ordering, or null + to use natural sort order
+
+ +

+CollatingIterator

+
+public CollatingIterator(java.util.Comparator comp,
+                         int initIterCapacity)
+
+
Constructs a new CollatingIterator that will used the + specified comparator for ordering and have the specified initial + capacity. Child iterators will have to be + manually added using the addIterator(Iterator) method. +

+

Parameters:
comp - the comparator to use for ordering, or null + to use natural sort order
initIterCapacity - the initial capacity for the internal list + of child iterators
+
+ +

+CollatingIterator

+
+public CollatingIterator(java.util.Comparator comp,
+                         java.util.Iterator a,
+                         java.util.Iterator b)
+
+
Constructs a new CollatingIterator that will use the + specified comparator to provide ordered iteration over the two + given iterators. +

+

Parameters:
comp - the comparator to use to sort, or null to use natural + sort order
a - the first child ordered iterator
b - the second child ordered iterator +
Throws: +
java.lang.NullPointerException - if either iterator is null
+
+ +

+CollatingIterator

+
+public CollatingIterator(java.util.Comparator comp,
+                         java.util.Iterator[] iterators)
+
+
Constructs a new CollatingIterator that will use the + specified comparator to provide ordered iteration over the array + of iterators. +

+

Parameters:
comp - the comparator to use to sort, or null to use natural + sort order
iterators - the array of iterators +
Throws: +
java.lang.NullPointerException - if iterators array is or contains null
+
+ +

+CollatingIterator

+
+public CollatingIterator(java.util.Comparator comp,
+                         java.util.Collection iterators)
+
+
Constructs a new CollatingIterator that will use the + specified comparator to provide ordered iteration over the collection + of iterators. +

+

Parameters:
comp - the comparator to use to sort, or null to use natural + sort order
iterators - the collection of iterators +
Throws: +
java.lang.NullPointerException - if the iterators collection is or contains null +
java.lang.ClassCastException - if the iterators collection contains an + element that's not an Iterator
+ + + + + + + + +
+Method Detail
+ +

+addIterator

+
+public void addIterator(java.util.Iterator iterator)
+
+
Add the given Iterator to my collection to collate. +

+

+
+
+
+ +
Throws: +
java.lang.IllegalStateException - if I've already started iterating +
java.lang.NullPointerException - if the iterator is null
+
+
+
+ +

+setIterator

+
+public void setIterator(int index,
+                        java.util.Iterator iterator)
+                 throws java.lang.IndexOutOfBoundsException
+
+
Set the Iterator at the given index +

+

+
+
+
+
Parameters:
index - index of the Iterator to replace
iterator - Iterator to place at the given index +
Throws: +
java.lang.IndexOutOfBoundsException - if index < 0 or index > size() +
java.lang.IllegalStateException - if I've already started iterating +
java.lang.NullPointerException - if the iterator is null
+
+
+
+ +

+getIterators

+
+public java.util.List getIterators()
+
+
Get the list of Iterators (unmodifiable) +

+

+
+
+
+ +
Returns:
the unmodifiable list of iterators added
+
+
+
+ +

+setComparator

+
+public void setComparator(java.util.Comparator comp)
+
+
Set the Comparator by which I collate. +

+

+
+
+
+ +
Throws: +
java.lang.IllegalStateException - if I've already started iterating
+
+
+
+ +

+getComparator

+
+public java.util.Comparator getComparator()
+
+
Get the Comparator by which I collate. +

+

+
+
+
+
+
+
+
+ +

+hasNext

+
+public boolean hasNext()
+
+
Returns true if any child iterator has remaining elements. +

+

+
Specified by:
hasNext in interface java.util.Iterator
+
+
+ +
Returns:
true if this iterator has remaining elements
+
+
+
+ +

+next

+
+public java.lang.Object next()
+                      throws java.util.NoSuchElementException
+
+
Returns the next ordered element from a child iterator. +

+

+
Specified by:
next in interface java.util.Iterator
+
+
+ +
Returns:
the next ordered element +
Throws: +
java.util.NoSuchElementException - if no child iterator has any more + elements
+
+
+
+ +

+remove

+
+public void remove()
+
+
Removes the last returned element from the child iterator that + produced it. +

+

+
Specified by:
remove in interface java.util.Iterator
+
+
+ +
Throws: +
java.lang.IllegalStateException - if there is no last returned element, + or if the last returned element has already been removed
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright © 2001-2004 The Apache Software Foundation. All Rights Reserved. + + Added: commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EmptyIterator.html URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EmptyIterator.html?rev=1422422&view=auto ============================================================================== --- commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EmptyIterator.html (added) +++ commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EmptyIterator.html Sat Dec 15 23:43:02 2012 @@ -0,0 +1,432 @@ + + + + + + +EmptyIterator (Collections 2.1.1 release API) + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.commons.collections.iterators +
+Class EmptyIterator

+
+java.lang.Object
+  |
+  +--org.apache.commons.collections.iterators.AbstractEmptyIterator
+        |
+        +--org.apache.commons.collections.iterators.EmptyIterator
+
+
+
All Implemented Interfaces:
java.util.Iterator
+
+
+
+
public final class EmptyIterator
extends org.apache.commons.collections.iterators.AbstractEmptyIterator
implements java.util.Iterator
+ +

+Provides an implementation of an empty iterator. +

+ This class provides an implementation of an empty iterator. + This class provides for binary compatability between Commons Collections + 2.1.1 and 3.1 due to issues with IteratorUtils. +

+ +

+

+
Since:
+
Commons Collections 2.1.1 and 3.1
+
Version:
+
$Revision: 1.1.2.2 $ $Date: 2004/05/22 11:54:53 $
+
Author:
+
Stephen Colebourne
+
+
+ +

+ + + + + + + + + + + + + + +
+Field Summary
+static java.util.IteratorINSTANCE + +
+          Singleton instance of the iterator.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidadd(java.lang.Object obj) + +
+           
+ booleanhasNext() + +
+           
+ booleanhasPrevious() + +
+           
+ java.lang.Objectnext() + +
+           
+ intnextIndex() + +
+           
+ java.lang.Objectprevious() + +
+           
+ intpreviousIndex() + +
+           
+ voidremove() + +
+           
+ voidset(java.lang.Object obj) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface java.util.Iterator
hasNext, next, remove
+  +

+ + + + + + + + +
+Field Detail
+ +

+INSTANCE

+
+public static final java.util.Iterator INSTANCE
+
+
Singleton instance of the iterator. +

+

+
Since:
+
Commons Collections 2.1.1 and 3.1
+
+
+ + + + + + + + + + + +
+Method Detail
+ +

+hasNext

+
+public boolean hasNext()
+
+
+
+
+
+
+ +

+next

+
+public java.lang.Object next()
+
+
+
+
+
+
+ +

+hasPrevious

+
+public boolean hasPrevious()
+
+
+
+
+
+
+ +

+previous

+
+public java.lang.Object previous()
+
+
+
+
+
+
+ +

+nextIndex

+
+public int nextIndex()
+
+
+
+
+
+
+ +

+previousIndex

+
+public int previousIndex()
+
+
+
+
+
+
+ +

+add

+
+public void add(java.lang.Object obj)
+
+
+
+
+
+
+ +

+set

+
+public void set(java.lang.Object obj)
+
+
+
+
+
+
+ +

+remove

+
+public void remove()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright © 2001-2004 The Apache Software Foundation. All Rights Reserved. + + Added: commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EmptyListIterator.html URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EmptyListIterator.html?rev=1422422&view=auto ============================================================================== --- commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EmptyListIterator.html (added) +++ commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EmptyListIterator.html Sat Dec 15 23:43:02 2012 @@ -0,0 +1,432 @@ + + + + + + +EmptyListIterator (Collections 2.1.1 release API) + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.commons.collections.iterators +
+Class EmptyListIterator

+
+java.lang.Object
+  |
+  +--org.apache.commons.collections.iterators.AbstractEmptyIterator
+        |
+        +--org.apache.commons.collections.iterators.EmptyListIterator
+
+
+
All Implemented Interfaces:
java.util.Iterator, java.util.ListIterator
+
+
+
+
public final class EmptyListIterator
extends org.apache.commons.collections.iterators.AbstractEmptyIterator
implements java.util.ListIterator
+ +

+Provides an implementation of an empty list iterator. +

+ This class provides an implementation of an empty list iterator. + This class provides for binary compatability between Commons Collections + 2.1.1 and 3.1 due to issues with IteratorUtils. +

+ +

+

+
Since:
+
Commons Collections 2.1.1 and 3.1
+
Version:
+
$Revision: 1.1.2.2 $ $Date: 2004/05/22 11:54:53 $
+
Author:
+
Stephen Colebourne
+
+
+ +

+ + + + + + + + + + + + + + +
+Field Summary
+static java.util.ListIteratorINSTANCE + +
+          Singleton instance of the iterator.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidadd(java.lang.Object obj) + +
+           
+ booleanhasNext() + +
+           
+ booleanhasPrevious() + +
+           
+ java.lang.Objectnext() + +
+           
+ intnextIndex() + +
+           
+ java.lang.Objectprevious() + +
+           
+ intpreviousIndex() + +
+           
+ voidremove() + +
+           
+ voidset(java.lang.Object obj) + +
+           
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ + + + + + + +
Methods inherited from interface java.util.ListIterator
add, hasNext, hasPrevious, next, nextIndex, previous, previousIndex, remove, set
+  +

+ + + + + + + + +
+Field Detail
+ +

+INSTANCE

+
+public static final java.util.ListIterator INSTANCE
+
+
Singleton instance of the iterator. +

+

+
Since:
+
Commons Collections 2.1.1 and 3.1
+
+
+ + + + + + + + + + + +
+Method Detail
+ +

+hasNext

+
+public boolean hasNext()
+
+
+
+
+
+
+ +

+next

+
+public java.lang.Object next()
+
+
+
+
+
+
+ +

+hasPrevious

+
+public boolean hasPrevious()
+
+
+
+
+
+
+ +

+previous

+
+public java.lang.Object previous()
+
+
+
+
+
+
+ +

+nextIndex

+
+public int nextIndex()
+
+
+
+
+
+
+ +

+previousIndex

+
+public int previousIndex()
+
+
+
+
+
+
+ +

+add

+
+public void add(java.lang.Object obj)
+
+
+
+
+
+
+ +

+set

+
+public void set(java.lang.Object obj)
+
+
+
+
+
+
+ +

+remove

+
+public void remove()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright © 2001-2004 The Apache Software Foundation. All Rights Reserved. + + Added: commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EnumerationIterator.html URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EnumerationIterator.html?rev=1422422&view=auto ============================================================================== --- commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EnumerationIterator.html (added) +++ commons/cms-site/trunk/collections/api-2.1.1/org/apache/commons/collections/iterators/EnumerationIterator.html Sat Dec 15 23:43:02 2012 @@ -0,0 +1,415 @@ + + + + + + +EnumerationIterator (Collections 2.1.1 release API) + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + +
+ +

+ +org.apache.commons.collections.iterators +
+Class EnumerationIterator

+
+java.lang.Object
+  |
+  +--org.apache.commons.collections.iterators.EnumerationIterator
+
+
+
All Implemented Interfaces:
java.util.Iterator
+
+
+
Direct Known Subclasses:
EnumerationIterator
+
+
+
+
public class EnumerationIterator
extends java.lang.Object
implements java.util.Iterator
+ +

+Adapter to make Enumeration instances appear + to be Iterator instances. +

+ +

+

+
Since:
+
1.0
+
Author:
+
James Strachan, Daniel Rall
+
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + +
+Constructor Summary
EnumerationIterator() + +
+          Constructs a new EnumerationIterator that will not + function until setEnumeration(Enumeration) is called.
EnumerationIterator(java.util.Enumeration enumeration) + +
+          Constructs a new EnumerationIterator that provides + an iterator view of the given enumeration.
EnumerationIterator(java.util.Enumeration enumeration, + java.util.Collection collection) + +
+          Constructs a new EnumerationIterator that will remove + elements from the specified collection.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ java.util.EnumerationgetEnumeration() + +
+          Returns the underlying enumeration.
+ booleanhasNext() + +
+          Returns true if the underlying enumeration has more elements.
+ java.lang.Objectnext() + +
+          Returns the next object from the enumeration.
+ voidremove() + +
+          Functions if an associated Collection is known.
+ voidsetEnumeration(java.util.Enumeration enumeration) + +
+          Sets the underlying enumeration.
+ + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + + + + +
+Constructor Detail
+ +

+EnumerationIterator

+
+public EnumerationIterator()
+
+
Constructs a new EnumerationIterator that will not + function until setEnumeration(Enumeration) is called. +

+

+
+ +

+EnumerationIterator

+
+public EnumerationIterator(java.util.Enumeration enumeration)
+
+
Constructs a new EnumerationIterator that provides + an iterator view of the given enumeration. +

+

Parameters:
enumeration - the enumeration to use
+
+ +

+EnumerationIterator

+
+public EnumerationIterator(java.util.Enumeration enumeration,
+                           java.util.Collection collection)
+
+
Constructs a new EnumerationIterator that will remove + elements from the specified collection. +

+

Parameters:
enumeration - the enumeration to use
collection - the collection to remove elements from
+ + + + + + + + +
+Method Detail
+ +

+hasNext

+
+public boolean hasNext()
+
+
Returns true if the underlying enumeration has more elements. +

+

+
Specified by:
hasNext in interface java.util.Iterator
+
+
+ +
Returns:
true if the underlying enumeration has more elements +
Throws: +
java.lang.NullPointerException - if the underlying enumeration is null
+
+
+
+ +

+next

+
+public java.lang.Object next()
+
+
Returns the next object from the enumeration. +

+

+
Specified by:
next in interface java.util.Iterator
+
+
+ +
Returns:
the next object from the enumeration +
Throws: +
java.lang.NullPointerException - if the enumeration is null
+
+
+
+ +

+remove

+
+public void remove()
+
+
Functions if an associated Collection is known. + If so, the first occurrence of the last returned object from this + iterator will be removed from the collection. +

+

+
Specified by:
remove in interface java.util.Iterator
+
+
+ +
Throws: +
java.lang.IllegalStateException - next() not called. +
java.lang.UnsupportedOperationException - No associated + Collection.
+
+
+
+ +

+getEnumeration

+
+public java.util.Enumeration getEnumeration()
+
+
Returns the underlying enumeration. +

+

+
+
+
+ +
Returns:
the underlying enumeration
+
+
+
+ +

+setEnumeration

+
+public void setEnumeration(java.util.Enumeration enumeration)
+
+
Sets the underlying enumeration. +

+

+
+
+
+
Parameters:
enumeration - the new underlying enumeration
+
+
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ + +
+Copyright © 2001-2004 The Apache Software Foundation. All Rights Reserved. + +