Javadoc format for <code>

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131204 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2003-09-29 22:02:33 +00:00
parent b6d03843b2
commit 22d14c1895
13 changed files with 61 additions and 61 deletions

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/CollatingIterator.java,v 1.7 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/CollatingIterator.java,v 1.8 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -74,7 +74,7 @@ import java.util.NoSuchElementException;
* <code>A.next()</code> and <code>B.next()</code>.
*
* @since Commons Collections 2.1
* @version $Revision: 1.7 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.8 $ $Date: 2003/09/29 22:02:33 $
*
* @author Rodney Waldhoff
* @author Stephen Colebourne
@ -100,7 +100,7 @@ public class CollatingIterator implements Iterator {
// -------------------------------------------------------------------
/**
* 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 @@ public class CollatingIterator implements Iterator {
}
/**
* 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 @@ public class CollatingIterator implements Iterator {
}
/**
* 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 @@ public class CollatingIterator implements Iterator {
}
/**
* 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 @@ public class CollatingIterator implements Iterator {
}
/**
* 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 @@ public class CollatingIterator implements Iterator {
}
/**
* 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 @@ public class CollatingIterator implements Iterator {
// -------------------------------------------------------------------
/**
* 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
*/

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/EnumerationIterator.java,v 1.3 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/EnumerationIterator.java,v 1.4 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -66,7 +66,7 @@ import java.util.Iterator;
* to be {@link Iterator Iterator} instances.
*
* @since Commons Collections 1.0
* @version $Revision: 1.3 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.4 $ $Date: 2003/09/29 22:02:33 $
*
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
* @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
@ -80,7 +80,7 @@ public class EnumerationIterator implements Iterator {
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 @@ public class EnumerationIterator implements Iterator {
}
/**
* 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 @@ public class EnumerationIterator implements Iterator {
}
/**
* 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

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/FilterIterator.java,v 1.4 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/FilterIterator.java,v 1.5 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -69,7 +69,7 @@ import org.apache.commons.collections.Predicate;
* returned.
*
* @since Commons Collections 1.0
* @version $Revision: 1.4 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.5 $ $Date: 2003/09/29 22:02:33 $
*
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
* @author Jan Sorensen
@ -87,7 +87,7 @@ public class FilterIterator extends ProxyIterator {
//-------------------------------------------------------------------------
/**
* 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 @@ public class FilterIterator extends ProxyIterator {
}
/**
* 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 @@ public class FilterIterator extends ProxyIterator {
}
/**
* 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

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/FilterListIterator.java,v 1.3 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/FilterListIterator.java,v 1.4 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -70,7 +70,7 @@ import org.apache.commons.collections.Predicate;
* returned by the iterator.
*
* @since Commons Collections 2.0
* @version $Revision: 1.3 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.4 $ $Date: 2003/09/29 22:02:33 $
*
* @author Rodney Waldhoff
*/
@ -80,7 +80,7 @@ public class FilterListIterator extends ProxyListIterator {
//-------------------------------------------------------------------------
/**
* 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 @@ public class FilterListIterator extends ProxyListIterator {
}
/**
* 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 @@ public class FilterListIterator extends ProxyListIterator {
}
/**
* 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 @@ public class FilterListIterator extends ProxyListIterator {
}
/**
* 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.

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/IteratorChain.java,v 1.5 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/IteratorChain.java,v 1.6 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -83,7 +83,7 @@ import java.util.NoSuchElementException;
* to not alter the underlying List of Iterators.</p>
*
* @since Commons Collections 2.1
* @version $Revision: 1.5 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.6 $ $Date: 2003/09/29 22:02:33 $
*
* @author Morgan Delagrange
* @author Stephen Colebourne
@ -127,7 +127,7 @@ public class IteratorChain implements Iterator {
}
/**
* 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 @@ public class IteratorChain implements Iterator {
}
/**
* 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 @@ public class IteratorChain implements Iterator {
}
/**
* 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

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/IteratorEnumeration.java,v 1.3 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/IteratorEnumeration.java,v 1.4 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -64,7 +64,7 @@ import java.util.Iterator;
* Adapter to make an {@link Iterator Iterator} instance appear to be an {@link Enumeration Enumeration} instances
*
* @since Commons Collections 1.0
* @version $Revision: 1.3 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.4 $ $Date: 2003/09/29 22:02:33 $
*
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
*/
@ -73,7 +73,7 @@ public class IteratorEnumeration implements Enumeration {
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 @@ public class IteratorEnumeration implements Enumeration {
}
/**
* 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

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ListIteratorWrapper.java,v 1.4 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ListIteratorWrapper.java,v 1.5 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -68,7 +68,7 @@ import java.util.NoSuchElementException;
* operations of ListIterator.
*
* @since Commons Collections 2.1
* @version $Revision: 1.4 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.5 $ $Date: 2003/09/29 22:02:33 $
*
* @author Morgan Delagrange
* @author Stephen Colebourne
@ -92,7 +92,7 @@ public class ListIteratorWrapper implements ListIterator {
//-------------------------------------------------------------------------
/**
* 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

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ProxyIterator.java,v 1.4 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ProxyIterator.java,v 1.5 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -64,7 +64,7 @@ import java.util.Iterator;
*
* @see ProxyListIterator
* @since Commons Collections 1.0
* @version $Revision: 1.4 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.5 $ $Date: 2003/09/29 22:02:33 $
*
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
*/
@ -77,7 +77,7 @@ public class ProxyIterator implements Iterator {
//-------------------------------------------------------------------------
/**
* 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 @@ public class ProxyIterator implements Iterator {
}
/**
* 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

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ProxyListIterator.java,v 1.4 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ProxyListIterator.java,v 1.5 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -65,7 +65,7 @@ import java.util.ListIterator;
*
* @see ProxyIterator
* @since Commons Collections 2.0
* @version $Revision: 1.4 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.5 $ $Date: 2003/09/29 22:02:33 $
*
* @author Rodney Waldhoff
*/
@ -78,7 +78,7 @@ public class ProxyListIterator implements ListIterator {
//-------------------------------------------------------------------------
/**
* 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 @@ public class ProxyListIterator implements ListIterator {
}
/**
* 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

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/SingletonIterator.java,v 1.5 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/SingletonIterator.java,v 1.6 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -64,7 +64,7 @@ import java.util.NoSuchElementException;
* object instance.</p>
*
* @since Commons Collections 2.0
* @version $Revision: 1.5 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.6 $ $Date: 2003/09/29 22:02:33 $
*
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
* @author Stephen Colebourne
@ -75,7 +75,7 @@ public class SingletonIterator implements ResetableIterator {
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
*/

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/SingletonListIterator.java,v 1.5 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/SingletonListIterator.java,v 1.6 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -63,7 +63,7 @@ import java.util.NoSuchElementException;
* object instance.</p>
*
* @since Commons Collections 2.1
* @version $Revision: 1.5 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.6 $ $Date: 2003/09/29 22:02:33 $
*
* @author Stephen Colebourne
*/
@ -74,7 +74,7 @@ public class SingletonListIterator implements ResetableListIterator {
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
*/

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/TransformIterator.java,v 1.4 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/TransformIterator.java,v 1.5 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -66,7 +66,7 @@ import org.apache.commons.collections.Transformer;
* some other form.
*
* @since Commons Collections 1.0
* @version $Revision: 1.4 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.5 $ $Date: 2003/09/29 22:02:33 $
*
* @author <a href="mailto:jstrachan@apache.org">James Strachan</a>
*/
@ -77,7 +77,7 @@ public class TransformIterator extends ProxyIterator {
/**
* 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 @@ public class TransformIterator extends ProxyIterator {
}
/**
* 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 @@ public class TransformIterator extends ProxyIterator {
}
/**
* 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.
*

View File

@ -1,5 +1,5 @@
/*
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/UniqueFilterIterator.java,v 1.5 2003/08/31 17:25:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/UniqueFilterIterator.java,v 1.6 2003/09/29 22:02:33 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -67,7 +67,7 @@ import org.apache.commons.collections.PredicateUtils;
* and duplicate Objects are skipped.
*
* @since Commons Collections 2.1
* @version $Revision: 1.5 $ $Date: 2003/08/31 17:25:49 $
* @version $Revision: 1.6 $ $Date: 2003/09/29 22:02:33 $
*
* @author Morgan Delagrange
*/
@ -76,7 +76,7 @@ public class UniqueFilterIterator extends FilterIterator {
//-------------------------------------------------------------------------
/**
* Constructs a new <Code>UniqueFilterIterator</Code>.
* Constructs a new <code>UniqueFilterIterator</code>.
*
* @param iterator the iterator to use
*/