You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by sc...@apache.org on 2003/09/30 00:02:34 UTC

cvs commit: jakarta-commons/collections/src/java/org/apache/commons/collections/iterators IteratorChain.java FilterIterator.java ProxyListIterator.java CollatingIterator.java UniqueFilterIterator.java FilterListIterator.java ListIteratorWrapper.java EnumerationIterator.java SingletonIterator.java TransformIterator.java SingletonListIterator.java ProxyIterator.java IteratorEnumeration.java

scolebourne    2003/09/29 15:02:34

  Modified:    collections/src/java/org/apache/commons/collections/iterators
                        IteratorChain.java FilterIterator.java
                        ProxyListIterator.java CollatingIterator.java
                        UniqueFilterIterator.java FilterListIterator.java
                        ListIteratorWrapper.java EnumerationIterator.java
                        SingletonIterator.java TransformIterator.java
                        SingletonListIterator.java ProxyIterator.java
                        IteratorEnumeration.java
  Log:
  Javadoc format for <code>
  
  Revision  Changes    Path
  1.6       +5 -5      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/IteratorChain.java
  
  Index: IteratorChain.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/IteratorChain.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- IteratorChain.java	31 Aug 2003 17:25:49 -0000	1.5
  +++ IteratorChain.java	29 Sep 2003 22:02:33 -0000	1.6
  @@ -127,7 +127,7 @@
       }
   
       /**
  -     * Constructs a new <Code>IteratorChain</Code> over the two
  +     * Constructs a new <code>IteratorChain</code> over the two
        * given iterators.
        *
        * @param a  the first child iterator
  @@ -141,7 +141,7 @@
       }
   
       /**
  -     * Constructs a new <Code>IteratorChain</Code> over the array
  +     * Constructs a new <code>IteratorChain</code> over the array
        * of iterators.
        *
        * @param iterators  the array of iterators
  @@ -155,7 +155,7 @@
       }
   
       /**
  -     * Constructs a new <Code>IteratorChain</Code> over the collection
  +     * Constructs a new <code>IteratorChain</code> over the collection
        * of iterators.
        *
        * @param iterators  the collection of iterators
  
  
  
  1.5       +5 -5      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/FilterIterator.java
  
  Index: FilterIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/FilterIterator.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- FilterIterator.java	31 Aug 2003 17:25:49 -0000	1.4
  +++ FilterIterator.java	29 Sep 2003 22:02:33 -0000	1.5
  @@ -87,7 +87,7 @@
       //-------------------------------------------------------------------------
   
       /**
  -     * Constructs a new <Code>FilterIterator</Code> that will not function
  +     * Constructs a new <code>FilterIterator</code> that will not function
        * until {@link #setIterator(Iterator) setIterator} is invoked.
        */
       public FilterIterator() {
  @@ -95,7 +95,7 @@
       }
       
       /**
  -     * Constructs a new <Code>FilterIterator</Code> that will not function
  +     * Constructs a new <code>FilterIterator</code> that will not function
        * until {@link #setPredicate(Predicate) setPredicate} is invoked.
        *
        * @param iterator  the iterator to use
  @@ -105,7 +105,7 @@
       }
   
       /**
  -     * Constructs a new <Code>FilterIterator</Code> that will use the
  +     * Constructs a new <code>FilterIterator</code> that will use the
        * given iterator and predicate.
        *
        * @param iterator  the iterator to use
  
  
  
  1.5       +4 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/ProxyListIterator.java
  
  Index: ProxyListIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/ProxyListIterator.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- ProxyListIterator.java	31 Aug 2003 17:25:49 -0000	1.4
  +++ ProxyListIterator.java	29 Sep 2003 22:02:33 -0000	1.5
  @@ -78,7 +78,7 @@
       //-------------------------------------------------------------------------
   
       /**
  -     * Constructs a new <Code>ProxyListIterator</Code> that will not 
  +     * Constructs a new <code>ProxyListIterator</code> that will not 
        * function until {@link #setListIterator(ListIterator) setListIterator}
        * is invoked.
        */
  @@ -87,7 +87,7 @@
       }
   
       /**
  -     * Constructs a new <Code>ProxyListIterator</Code> that will use the
  +     * Constructs a new <code>ProxyListIterator</code> that will use the
        * given list iterator.
        *
        * @param iterator  the list iterator to use
  
  
  
  1.8       +11 -11    jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/CollatingIterator.java
  
  Index: CollatingIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/CollatingIterator.java,v
  retrieving revision 1.7
  retrieving revision 1.8
  diff -u -r1.7 -r1.8
  --- CollatingIterator.java	31 Aug 2003 17:25:49 -0000	1.7
  +++ CollatingIterator.java	29 Sep 2003 22:02:33 -0000	1.8
  @@ -100,7 +100,7 @@
       // -------------------------------------------------------------------
       
       /**
  -     * Constructs a new <Code>CollatingIterator</Code>.  Natural sort order
  +     * Constructs a new <code>CollatingIterator</code>.  Natural sort order
        * will be used, and child iterators will have to be manually added 
        * using the {@link #addIterator(Iterator)} method.
        */
  @@ -109,11 +109,11 @@
       }
       
       /**
  -     * Constructs a new <Code>CollatingIterator</Code> that will used the
  +     * Constructs a new <code>CollatingIterator</code> that will used the
        * specified comparator for ordering.  Child iterators will have to be 
        * manually added using the {@link #addIterator(Iterator)} method.
        *
  -     * @param comp  the comparator to use for ordering, or <Code>null</Code>
  +     * @param comp  the comparator to use for ordering, or <code>null</code>
        *    to use natural sort order
        */
       public CollatingIterator(Comparator comp) {
  @@ -121,12 +121,12 @@
       }
       
       /**
  -     * Constructs a new <Code>CollatingIterator</Code> that will used the
  +     * Constructs a new <code>CollatingIterator</code> that will used the
        * specified comparator for ordering and have the specified initial
        * capacity.  Child iterators will have to be 
        * manually added using the {@link #addIterator(Iterator)} method.
        *
  -     * @param comp  the comparator to use for ordering, or <Code>null</Code>
  +     * @param comp  the comparator to use for ordering, or <code>null</code>
        *    to use natural sort order
        * @param initIterCapacity  the initial capacity for the internal list
        *    of child iterators
  @@ -137,7 +137,7 @@
       }
   
       /**
  -     * Constructs a new <Code>CollatingIterator</Code> that will use the
  +     * Constructs a new <code>CollatingIterator</code> that will use the
        * specified comparator to provide ordered iteration over the two
        * given iterators.
        *
  @@ -154,7 +154,7 @@
       }
   
       /**
  -     * Constructs a new <Code>CollatingIterator</Code> that will use the
  +     * Constructs a new <code>CollatingIterator</code> that will use the
        * specified comparator to provide ordered iteration over the array
        * of iterators.
        *
  @@ -171,7 +171,7 @@
       }
   
       /**
  -     * Constructs a new <Code>CollatingIterator</Code> that will use the
  +     * Constructs a new <code>CollatingIterator</code> that will use the
        * specified comparator to provide ordered iteration over the collection
        * of iterators.
        *
  @@ -252,7 +252,7 @@
       // -------------------------------------------------------------------
   
       /**
  -     *  Returns <Code>true</Code> if any child iterator has remaining elements.
  +     *  Returns <code>true</code> if any child iterator has remaining elements.
        *
        *  @return true if this iterator has remaining elements
        */
  
  
  
  1.6       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/UniqueFilterIterator.java
  
  Index: UniqueFilterIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/UniqueFilterIterator.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- UniqueFilterIterator.java	31 Aug 2003 17:25:49 -0000	1.5
  +++ UniqueFilterIterator.java	29 Sep 2003 22:02:33 -0000	1.6
  @@ -76,7 +76,7 @@
       //-------------------------------------------------------------------------
       
       /**
  -     *  Constructs a new <Code>UniqueFilterIterator</Code>.
  +     *  Constructs a new <code>UniqueFilterIterator</code>.
        *
        *  @param iterator  the iterator to use
        */
  
  
  
  1.4       +6 -6      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/FilterListIterator.java
  
  Index: FilterListIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/FilterListIterator.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- FilterListIterator.java	31 Aug 2003 17:25:49 -0000	1.3
  +++ FilterListIterator.java	29 Sep 2003 22:02:33 -0000	1.4
  @@ -80,7 +80,7 @@
       //-------------------------------------------------------------------------
       
       /**
  -     *  Constructs a new <Code>FilterListIterator</Code> that will not 
  +     *  Constructs a new <code>FilterListIterator</code> that will not 
        *  function until 
        *  {@link ProxyListIterator#setListIterator(ListIterator) setListIterator}
        *  and {@link #setPredicate(Predicate) setPredicate} are invoked.
  @@ -90,7 +90,7 @@
       }
   
       /**
  -     * Constructs a new <Code>FilterListIterator</Code> that will not 
  +     * Constructs a new <code>FilterListIterator</code> that will not 
        * function until {@link #setPredicate(Predicate) setPredicate} is invoked.
        *
        * @param iterator  the iterator to use
  @@ -100,7 +100,7 @@
       }
   
       /**
  -     * Constructs a new <Code>FilterListIterator</Code>.
  +     * Constructs a new <code>FilterListIterator</code>.
        *
        * @param iterator  the iterator to use
        * @param predicate  the predicate to use
  @@ -111,7 +111,7 @@
       }
   
       /**
  -     * Constructs a new <Code>FilterListIterator</Code> that will not 
  +     * Constructs a new <code>FilterListIterator</code> that will not 
        * function until 
        * {@link ProxyListIterator#setListIterator(ListIterator) setListIterator}
        * is invoked.
  
  
  
  1.5       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/ListIteratorWrapper.java
  
  Index: ListIteratorWrapper.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/ListIteratorWrapper.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- ListIteratorWrapper.java	31 Aug 2003 17:25:49 -0000	1.4
  +++ ListIteratorWrapper.java	29 Sep 2003 22:02:33 -0000	1.5
  @@ -92,7 +92,7 @@
       //-------------------------------------------------------------------------
   
       /**
  -     * Constructs a new <Code>ListIteratorWrapper</Code> that will wrap
  +     * Constructs a new <code>ListIteratorWrapper</code> that will wrap
        * the given iterator.
        *
        * @param iterator  the iterator to wrap
  
  
  
  1.4       +5 -5      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/EnumerationIterator.java
  
  Index: EnumerationIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/EnumerationIterator.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- EnumerationIterator.java	31 Aug 2003 17:25:49 -0000	1.3
  +++ EnumerationIterator.java	29 Sep 2003 22:02:33 -0000	1.4
  @@ -80,7 +80,7 @@
       private Object last;
       
       /**
  -     *  Constructs a new <Code>EnumerationIterator</Code> that will not
  +     *  Constructs a new <code>EnumerationIterator</code> that will not
        *  function until {@link #setEnumeration(Enumeration)} is called.
        */
       public EnumerationIterator() {
  @@ -88,7 +88,7 @@
       }
   
       /**
  -     *  Constructs a new <Code>EnumerationIterator</Code> that provides
  +     *  Constructs a new <code>EnumerationIterator</code> that provides
        *  an iterator view of the given enumeration.
        *
        *  @param enumeration  the enumeration to use
  @@ -98,7 +98,7 @@
       }
   
       /**
  -     *  Constructs a new <Code>EnumerationIterator</Code> that will remove
  +     *  Constructs a new <code>EnumerationIterator</code> that will remove
        *  elements from the specified collection.
        *
        *  @param enum  the enumeration to use
  
  
  
  1.6       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/SingletonIterator.java
  
  Index: SingletonIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/SingletonIterator.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- SingletonIterator.java	31 Aug 2003 17:25:49 -0000	1.5
  +++ SingletonIterator.java	29 Sep 2003 22:02:33 -0000	1.6
  @@ -75,7 +75,7 @@
       private Object object;
   
       /**
  -     * Constructs a new <Code>SingletonIterator</Code>.
  +     * Constructs a new <code>SingletonIterator</code>.
        *
        * @param object  the single object to return from the iterator
        */
  
  
  
  1.5       +5 -5      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/TransformIterator.java
  
  Index: TransformIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/TransformIterator.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- TransformIterator.java	31 Aug 2003 17:25:49 -0000	1.4
  +++ TransformIterator.java	29 Sep 2003 22:02:33 -0000	1.5
  @@ -77,7 +77,7 @@
       
       
       /**
  -     * Constructs a new <Code>TransformIterator</Code> that will not function
  +     * Constructs a new <code>TransformIterator</code> that will not function
        * until the {@link #setIterator(Iterator) setIterator} method is 
        * invoked.
        */
  @@ -86,7 +86,7 @@
       }
       
       /**
  -     * Constructs a new <Code>TransformIterator</Code> that won't transform
  +     * Constructs a new <code>TransformIterator</code> that won't transform
        * elements from the given iterator.
        *
        * @param iterator  the iterator to use
  @@ -96,7 +96,7 @@
       }
   
       /**
  -     * Constructs a new <Code>TransformIterator</Code> that will use the
  +     * Constructs a new <code>TransformIterator</code> that will use the
        * given iterator and transformer.  If the given transformer is null,
        * then objects will not be transformed.
        *
  
  
  
  1.6       +3 -3      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/SingletonListIterator.java
  
  Index: SingletonListIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/SingletonListIterator.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- SingletonListIterator.java	31 Aug 2003 17:25:49 -0000	1.5
  +++ SingletonListIterator.java	29 Sep 2003 22:02:33 -0000	1.6
  @@ -74,7 +74,7 @@
       private Object object;
   
       /**
  -     * Constructs a new <Code>SingletonListIterator</Code>.
  +     * Constructs a new <code>SingletonListIterator</code>.
        *
        * @param object  the single object to return from the iterator
        */
  
  
  
  1.5       +4 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/ProxyIterator.java
  
  Index: ProxyIterator.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/ProxyIterator.java,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- ProxyIterator.java	31 Aug 2003 17:25:49 -0000	1.4
  +++ ProxyIterator.java	29 Sep 2003 22:02:33 -0000	1.5
  @@ -77,7 +77,7 @@
       //-------------------------------------------------------------------------
   
       /**
  -     * Constructs a new <Code>ProxyIterator</Code> that will not function
  +     * Constructs a new <code>ProxyIterator</code> that will not function
        * until {@link #setIterator(Iterator)} is called.
        */
       public ProxyIterator() {
  @@ -85,7 +85,7 @@
       }
       
       /**
  -     * Constructs a new <Code>ProxyIterator</Code> that will use the
  +     * Constructs a new <code>ProxyIterator</code> that will use the
        * given iterator.
        *
        * @param iterator  the underlying iterator
  
  
  
  1.4       +4 -4      jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/IteratorEnumeration.java
  
  Index: IteratorEnumeration.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/collections/src/java/org/apache/commons/collections/iterators/IteratorEnumeration.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- IteratorEnumeration.java	31 Aug 2003 17:25:49 -0000	1.3
  +++ IteratorEnumeration.java	29 Sep 2003 22:02:33 -0000	1.4
  @@ -73,7 +73,7 @@
       private Iterator iterator;
       
       /**
  -     * Constructs a new <Code>IteratorEnumeration</Code> that will not 
  +     * Constructs a new <code>IteratorEnumeration</code> that will not 
        * function until {@link #setIterator(Iterator) setIterator} is  
        * invoked.
        */
  @@ -82,7 +82,7 @@
       }
   
       /**
  -     * Constructs a new <Code>IteratorEnumeration</Code> that will use
  +     * Constructs a new <code>IteratorEnumeration</code> that will use
        * the given iterator. 
        * 
        * @param iterator  the iterator to use