Apache
/
commons-collections
mirror of https://github.com/apache/commons-collections.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix spellings and javadoc 

bug 25937, from Janek Bogucki


git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@131538 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2004-01-08 22:37:31 +00:00
parent 81cf8ee877
commit e97baa4b4a
29 changed files with 103 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/java/org/apache/commons/collections/bag/AbstractMapBag.java
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/bag/AbstractMapBag.java,v 1.11 2004/01/08 22:26:08 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/bag/AbstractMapBag.java,v 1.12 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -79,7 +79,7 @@ import org.apache.commons.collections.set.UnmodifiableSet;
* the number of occurrences of that element in the bag.
*
* @since Commons Collections 3.0 (previously DefaultMapBag v2.0)
* @version $Revision: 1.11 $ $Date: 2004/01/08 22:26:08 $
* @version $Revision: 1.12 $ $Date: 2004/01/08 22:37:30 $
*
* @author Chuck Burdick
* @author Michael A. Smith
@ -538,7 +538,7 @@ public abstract class AbstractMapBag implements Bag {
//-----------------------------------------------------------------------
/**
* Compares this Bag to another.
* This Bag equals another Bag if it contains the same number of occurances of
* This Bag equals another Bag if it contains the same number of occurrences of
* the same elements.
*
* @param object the Bag to compare to
@ -565,11 +565,11 @@ public abstract class AbstractMapBag implements Bag {
}
/**
* Gets a hash code for the Bag compatable with the definition of equals.
* Gets a hash code for the Bag compatible with the definition of equals.
* The hash code is defined as the sum total of a hash code for each element.
* The per element hash code is defined as
* <code>(e==null ? 0 : e.hashCode()) ^ noOccurances)</code>.
* This hash code is compatable with the Set interface.
* This hash code is compatible with the Set interface.
*
* @return the hash code of the Bag
*/

6
src/java/org/apache/commons/collections/bag/HashBag.java
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/bag/HashBag.java,v 1.5 2004/01/05 21:54:06 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/bag/HashBag.java,v 1.6 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -71,13 +71,13 @@ import org.apache.commons.collections.Bag;
* data storage. This is the standard implementation of a bag.
* <p>
* A <code>Bag</code> stores each object in the collection together with a
* count of occurances. Extra methods on the interface allow multiple copies
* count of occurrences. Extra methods on the interface allow multiple copies
* of an object to be added or removed at once. It is important to read the
* interface javadoc carefully as several methods violate the
* <code>Collection</code> interface specification.
*
* @since Commons Collections 3.0 (previously in main package v2.0)
* @version $Revision: 1.5 $ $Date: 2004/01/05 21:54:06 $
* @version $Revision: 1.6 $ $Date: 2004/01/08 22:37:30 $
*
* @author Chuck Burdick
* @author Stephen Colebourne

6
src/java/org/apache/commons/collections/bag/TreeBag.java
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/bag/TreeBag.java,v 1.6 2004/01/05 21:54:06 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/bag/TreeBag.java,v 1.7 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -76,13 +76,13 @@ import org.apache.commons.collections.SortedBag;
* iterator.
* <p>
* A <code>Bag</code> stores each object in the collection together with a
* count of occurances. Extra methods on the interface allow multiple copies
* count of occurrences. Extra methods on the interface allow multiple copies
* of an object to be added or removed at once. It is important to read the
* interface javadoc carefully as several methods violate the
* <code>Collection</code> interface specification.
*
* @since Commons Collections 3.0 (previously in main package v2.0)
* @version $Revision: 1.6 $ $Date: 2004/01/05 21:54:06 $
* @version $Revision: 1.7 $ $Date: 2004/01/08 22:37:30 $
*
* @author Chuck Burdick
* @author Stephen Colebourne

6
src/java/org/apache/commons/collections/bidimap/DualHashBidiMap.java
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/bidimap/DualHashBidiMap.java,v 1.3 2004/01/05 21:46:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/bidimap/DualHashBidiMap.java,v 1.4 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -70,7 +70,7 @@ import org.apache.commons.collections.BidiMap;
* Implementation of <code>BidiMap</code> that uses two <code>HashMap</code> instances.
*
* @since Commons Collections 3.0
* @version $Id: DualHashBidiMap.java,v 1.3 2004/01/05 21:46:49 scolebourne Exp $
* @version $Id: DualHashBidiMap.java,v 1.4 2004/01/08 22:37:30 scolebourne Exp $
*
* @author Matthew Hawthorne
* @author Stephen Colebourne
@ -78,7 +78,7 @@ import org.apache.commons.collections.BidiMap;
public class DualHashBidiMap
extends AbstractDualBidiMap implements Serializable {
/** Ensure serialization compatability */
/** Ensure serialization compatibility */
private static final long serialVersionUID = 721969328361808L;
/**

6
src/java/org/apache/commons/collections/bidimap/DualTreeBidiMap.java
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/bidimap/DualTreeBidiMap.java,v 1.9 2004/01/05 21:46:49 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/bidimap/DualTreeBidiMap.java,v 1.10 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -88,7 +88,7 @@ import org.apache.commons.collections.map.AbstractSortedMapDecorator;
* not store each object twice, which can save on memory use.
*
* @since Commons Collections 3.0
* @version $Id: DualTreeBidiMap.java,v 1.9 2004/01/05 21:46:49 scolebourne Exp $
* @version $Id: DualTreeBidiMap.java,v 1.10 2004/01/08 22:37:30 scolebourne Exp $
*
* @author Matthew Hawthorne
* @author Stephen Colebourne
@ -96,7 +96,7 @@ import org.apache.commons.collections.map.AbstractSortedMapDecorator;
public class DualTreeBidiMap
extends AbstractDualBidiMap implements SortedBidiMap, Serializable {
/** Ensure serialization compatability */
/** Ensure serialization compatibility */
private static final long serialVersionUID = 721969328361809L;
/** The comparator to use */
protected final Comparator comparator;

6
src/java/org/apache/commons/collections/buffer/PriorityBuffer.java
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/buffer/PriorityBuffer.java,v 1.1 2004/01/02 02:14:29 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/buffer/PriorityBuffer.java,v 1.2 2004/01/08 22:37:31 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -92,7 +92,7 @@ import org.apache.commons.collections.BufferUnderflowException;
* </pre>
*
* @since Commons Collections 3.0 (previously BinaryHeap v1.0)
* @version $Revision: 1.1 $ $Date: 2004/01/02 02:14:29 $
* @version $Revision: 1.2 $ $Date: 2004/01/08 22:37:31 $
*
* @author Peter Donald
* @author Ram Chidambaram
@ -341,7 +341,7 @@ public class PriorityBuffer extends AbstractCollection implements Buffer {
/**
* Percolates element down heap from the position given by the index.
* <p>
* Assumes it is a mimimum heap.
* Assumes it is a minimum heap.
*
* @param index the index for the element
*/

6
src/java/org/apache/commons/collections/comparators/NullComparator.java
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/comparators/NullComparator.java,v 1.9 2003/10/09 20:44:32 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/comparators/NullComparator.java,v 1.10 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
* The Apache Software License, Version 1.1
*
@ -64,7 +64,7 @@ import java.util.Comparator;
* other objects.
*
* @since Commons Collections 2.0
* @version $Revision: 1.9 $ $Date: 2003/10/09 20:44:32 $
* @version $Revision: 1.10 $ $Date: 2004/01/08 22:37:29 $
*
* @author Michael A. Smith
*/
@ -125,7 +125,7 @@ public class NullComparator implements Comparator, Serializable {
}
/**
* Cosntruct an instance that sorts <code>null</code> higher or lower than
* Construct an instance that sorts <code>null</code> higher or lower than
* any non-<code>null</code> object it is compared with. When comparing
* two non-<code>null</code> objects, the specified {@link Comparator} is
* used.

6
src/java/org/apache/commons/collections/functors/ChainedClosure.java
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/functors/ChainedClosure.java,v 1.1 2003/11/23 17:01:35 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/functors/ChainedClosure.java,v 1.2 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -64,10 +64,10 @@ import java.util.Iterator;
import org.apache.commons.collections.Closure;
/**
* Closure implementation that chains the specifed closures together.
* Closure implementation that chains the specified closures together.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/23 17:01:35 $
* @version $Revision: 1.2 $ $Date: 2004/01/08 22:37:29 $
*
* @author Stephen Colebourne
*/

6
src/java/org/apache/commons/collections/functors/ChainedTransformer.java
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/functors/ChainedTransformer.java,v 1.2 2004/01/02 01:36:51 psteitz Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/functors/ChainedTransformer.java,v 1.3 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -64,10 +64,10 @@ import java.util.Iterator;
import org.apache.commons.collections.Transformer;
/**
* Transformer implementation that chains the specifed closures together.
* Transformer implementation that chains the specified closures together.
*
* @since Commons Collections 3.0
* @version $Revision: 1.2 $ $Date: 2004/01/02 01:36:51 $
* @version $Revision: 1.3 $ $Date: 2004/01/08 22:37:29 $
*
* @author Stephen Colebourne
*/

6
src/java/org/apache/commons/collections/functors/StringValueTransformer.java
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/functors/StringValueTransformer.java,v 1.1 2003/11/23 23:25:33 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/functors/StringValueTransformer.java,v 1.2 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -62,10 +62,10 @@ import java.io.Serializable;
import org.apache.commons.collections.Transformer;
/**
* Transformer implementation that returns the <code>String.valueof</code>.
* Transformer implementation that returns the <code>String.valueOf</code>.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/23 23:25:33 $
* @version $Revision: 1.2 $ $Date: 2004/01/08 22:37:29 $
*
* @author Stephen Colebourne
*/

6
src/java/org/apache/commons/collections/iterators/ArrayIterator.java
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/ArrayIterator.java,v 1.8 2003/12/01 22:49:00 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/ArrayIterator.java,v 1.9 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -74,7 +74,7 @@ import org.apache.commons.collections.ResettableIterator;
* the iterator back to the start if required.
*
* @since Commons Collections 1.0
* @version $Revision: 1.8 $ $Date: 2003/12/01 22:49:00 $
* @version $Revision: 1.9 $ $Date: 2004/01/08 22:37:29 $
*
* @author James Strachan
* @author Mauricio S. Moura
@ -164,7 +164,7 @@ public class ArrayIterator implements ResettableIterator {
* Checks whether the index is valid or not.
*
* @param bound the index to check
* @param type the index type (for error messges)
* @param type the index type (for error messages)
* @throws IndexOutOfBoundsException if the index is invalid
*/
protected void checkBound(final int bound, final String type ) {

6
src/java/org/apache/commons/collections/iterators/IteratorChain.java
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.9 2004/01/08 22:26:07 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.10 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -68,7 +68,7 @@ import org.apache.commons.collections.list.UnmodifiableList;
/**
* An IteratorChain is an Iterator that wraps a number of Iterators.
* <p>
* This class makes mutiple iterators look like one to the caller
* This class makes multiple iterators look like one to the caller
* When any method from the Iterator interface is called, the IteratorChain
* will delegate to a single underlying Iterator. The IteratorChain will
* invoke the Iterators in sequence until all Iterators are exhausted.
@ -85,7 +85,7 @@ import org.apache.commons.collections.list.UnmodifiableList;
* iterators. In this case the class will function as an empty iterator.
*
* @since Commons Collections 2.1
* @version $Revision: 1.9 $ $Date: 2004/01/08 22:26:07 $
* @version $Revision: 1.10 $ $Date: 2004/01/08 22:37:29 $
*
* @author Morgan Delagrange
* @author Stephen Colebourne

8
src/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java
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/UnmodifiableIterator.java,v 1.2 2003/12/03 12:27:37 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java,v 1.3 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -65,7 +65,7 @@ import org.apache.commons.collections.Unmodifiable;
* Decorates an iterator such that it cannot be modified.
*
* @since Commons Collections 3.0
* @version $Revision: 1.2 $ $Date: 2003/12/03 12:27:37 $
* @version $Revision: 1.3 $ $Date: 2004/01/08 22:37:29 $
*
* @author Stephen Colebourne
*/
@ -80,7 +80,7 @@ public final class UnmodifiableIterator implements Iterator, Unmodifiable {
* <p>
* If the iterator is already unmodifiable it is returned directly.
*
* @param iterator the iterator to decoarate
* @param iterator the iterator to decorate
* @throws IllegalArgumentException if the iterator is null
*/
public static Iterator decorate(Iterator iterator) {
@ -97,7 +97,7 @@ public final class UnmodifiableIterator implements Iterator, Unmodifiable {
/**
* Constructor.
*
* @param iterator the iterator to decoarate
* @param iterator the iterator to decorate
*/
private UnmodifiableIterator(Iterator iterator) {
super();

8
src/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java
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/UnmodifiableListIterator.java,v 1.2 2003/12/03 12:27:37 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java,v 1.3 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -65,7 +65,7 @@ import org.apache.commons.collections.Unmodifiable;
* Decorates a list iterator such that it cannot be modified.
*
* @since Commons Collections 3.0
* @version $Revision: 1.2 $ $Date: 2003/12/03 12:27:37 $
* @version $Revision: 1.3 $ $Date: 2004/01/08 22:37:29 $
*
* @author Stephen Colebourne
*/
@ -78,7 +78,7 @@ public final class UnmodifiableListIterator implements ListIterator, Unmodifiabl
/**
* Decorates the specified iterator such that it cannot be modified.
*
* @param iterator the iterator to decoarate
* @param iterator the iterator to decorate
* @throws IllegalArgumentException if the iterator is null
*/
public static ListIterator decorate(ListIterator iterator) {
@ -95,7 +95,7 @@ public final class UnmodifiableListIterator implements ListIterator, Unmodifiabl
/**
* Constructor.
*
* @param iterator the iterator to decoarate
* @param iterator the iterator to decorate
*/
private UnmodifiableListIterator(ListIterator iterator) {
super();

8
src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java
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/UnmodifiableMapIterator.java,v 1.4 2003/12/03 12:27:37 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java,v 1.5 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -64,7 +64,7 @@ import org.apache.commons.collections.Unmodifiable;
* Decorates a map iterator such that it cannot be modified.
*
* @since Commons Collections 3.0
* @version $Revision: 1.4 $ $Date: 2003/12/03 12:27:37 $
* @version $Revision: 1.5 $ $Date: 2004/01/08 22:37:29 $
*
* @author Stephen Colebourne
*/
@ -77,7 +77,7 @@ public final class UnmodifiableMapIterator implements MapIterator, Unmodifiable
/**
* Decorates the specified iterator such that it cannot be modified.
*
* @param iterator the iterator to decoarate
* @param iterator the iterator to decorate
* @throws IllegalArgumentException if the iterator is null
*/
public static MapIterator decorate(MapIterator iterator) {
@ -94,7 +94,7 @@ public final class UnmodifiableMapIterator implements MapIterator, Unmodifiable
/**
* Constructor.
*
* @param iterator the iterator to decoarate
* @param iterator the iterator to decorate
*/
private UnmodifiableMapIterator(MapIterator iterator) {
super();

8
src/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java
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/UnmodifiableOrderedMapIterator.java,v 1.3 2003/12/03 12:27:37 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java,v 1.4 2004/01/08 22:37:29 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -64,7 +64,7 @@ import org.apache.commons.collections.Unmodifiable;
* Decorates an ordered map iterator such that it cannot be modified.
*
* @since Commons Collections 3.0
* @version $Revision: 1.3 $ $Date: 2003/12/03 12:27:37 $
* @version $Revision: 1.4 $ $Date: 2004/01/08 22:37:29 $
*
* @author Stephen Colebourne
*/
@ -77,7 +77,7 @@ public final class UnmodifiableOrderedMapIterator implements OrderedMapIterator,
/**
* Decorates the specified iterator such that it cannot be modified.
*
* @param iterator the iterator to decoarate
* @param iterator the iterator to decorate
* @throws IllegalArgumentException if the iterator is null
*/
public static OrderedMapIterator decorate(OrderedMapIterator iterator) {
@ -94,7 +94,7 @@ public final class UnmodifiableOrderedMapIterator implements OrderedMapIterator,
/**
* Constructor.
*
* @param iterator the iterator to decoarate
* @param iterator the iterator to decorate
*/
private UnmodifiableOrderedMapIterator(OrderedMapIterator iterator) {
super();

6
src/java/org/apache/commons/collections/keyvalue/AbstractMapEntry.java
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/keyvalue/AbstractMapEntry.java,v 1.1 2003/12/05 20:23:56 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/keyvalue/AbstractMapEntry.java,v 1.2 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -63,7 +63,7 @@ import java.util.Map;
* Abstract Pair class to assist with creating correct Map Entry implementations.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/12/05 20:23:56 $
* @version $Revision: 1.2 $ $Date: 2004/01/08 22:37:30 $
*
* @author James Strachan
* @author Michael A. Smith
@ -124,7 +124,7 @@ public abstract class AbstractMapEntry extends AbstractKeyValue implements Map.E
* <p>
* Implemented per API documentation of {@link java.util.Map.Entry#hashCode()}
*
* @return a suitable hashcode
* @return a suitable hash code
*/
public int hashCode() {
return (getKey() == null ? 0 : getKey().hashCode()) ^

6
src/java/org/apache/commons/collections/keyvalue/DefaultKeyValue.java
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/keyvalue/DefaultKeyValue.java,v 1.1 2003/12/05 20:23:56 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/keyvalue/DefaultKeyValue.java,v 1.2 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -68,7 +68,7 @@ import org.apache.commons.collections.KeyValue;
* itself as a key or value.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/12/05 20:23:56 $
* @version $Revision: 1.2 $ $Date: 2004/01/08 22:37:30 $
*
* @author James Strachan
* @author Michael A. Smith
@ -189,7 +189,7 @@ public class DefaultKeyValue extends AbstractKeyValue {
* Implemented per API documentation of {@link java.util.Map.Entry#hashCode()},
* however subclasses may override this.
*
* @return a suitable hashcode
* @return a suitable hash code
*/
public int hashCode() {
return (getKey() == null ? 0 : getKey().hashCode()) ^

8
src/java/org/apache/commons/collections/keyvalue/MultiKey.java
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/keyvalue/MultiKey.java,v 1.1 2003/12/05 20:23:56 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/keyvalue/MultiKey.java,v 1.2 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -69,7 +69,7 @@ import java.util.Arrays;
* can be used instead by creating an instance passing in the key and locale.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/12/05 20:23:56 $
* @version $Revision: 1.2 $ $Date: 2004/01/08 22:37:30 $
*
* @author Howard Lewis Ship
* @author Stephen Colebourne
@ -203,14 +203,14 @@ public class MultiKey implements Serializable {
}
/**
* Gets the combined hashcode that is computed from all the keys.
* Gets the combined hash code that is computed from all the keys.
* <p>
* This value is computed once and then cached, so elements should not
* change their hash codes once created (note that this is the same
* constraint that would be used if the individual keys elements were
* themselves {@link java.util.Map Map} keys.
*
* @return the hashcode
* @return the hash code
*/
public int hashCode() {
return hashCode;

6
src/java/org/apache/commons/collections/keyvalue/TiedMapEntry.java
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/keyvalue/TiedMapEntry.java,v 1.1 2003/12/05 20:23:56 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/keyvalue/TiedMapEntry.java,v 1.2 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -68,7 +68,7 @@ import org.apache.commons.collections.KeyValue;
* map, however this will probably mess up any iterators.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/12/05 20:23:56 $
* @version $Revision: 1.2 $ $Date: 2004/01/08 22:37:30 $
*
* @author Stephen Colebourne
*/
@ -152,7 +152,7 @@ public class TiedMapEntry implements Map.Entry, KeyValue {
* <p>
* Implemented per API documentation of {@link java.util.Map.Entry#hashCode()}
*
* @return a suitable hashcode
* @return a suitable hash code
*/
public int hashCode() {
Object value = getValue();

6
src/java/org/apache/commons/collections/list/AbstractLinkedList.java
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/list/AbstractLinkedList.java,v 1.5 2003/12/29 01:04:44 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/list/AbstractLinkedList.java,v 1.6 2004/01/08 22:37:31 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -80,7 +80,7 @@ import org.apache.commons.collections.OrderedIterator;
* is here.
*
* @since Commons Collections 3.0
* @version $Revision: 1.5 $ $Date: 2003/12/29 01:04:44 $
* @version $Revision: 1.6 $ $Date: 2004/01/08 22:37:31 $
*
* @author Rich Dougherty
* @author Phil Steitz
@ -701,7 +701,7 @@ public abstract class AbstractLinkedList implements List {
* #previous()}. Set to <code>null</code> if {@link #next()} or {@link
* #previous()} haven't been called, or if the node has been removed
* with {@link #remove()} or a new node added with {@link #add(Object)}.
* Should be accesed through {@link #getLastNodeReturned()} to enforce
* Should be accessed through {@link #getLastNodeReturned()} to enforce
* this behaviour.
*/
protected Node current;

8
src/java/org/apache/commons/collections/list/CursorableLinkedList.java
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/list/CursorableLinkedList.java,v 1.2 2003/12/29 00:38:08 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/list/CursorableLinkedList.java,v 1.3 2004/01/08 22:37:31 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -84,7 +84,7 @@ import java.util.ListIterator;
* with changes to the iterator. Note that the {@link #iterator()} method and
* sublists do <b>not</b> provide this cursor behaviour.
* <p>
* The <code>Cursor</code> class is provided partly for backwards compatability
* The <code>Cursor</code> class is provided partly for backwards compatibility
* and partly because it allows the cursor to be directly closed. Closing the
* cursor is optional because references are held via a <code>WeakReference</code>.
* For most purposes, simply modify the iterator and list at will, and then let
@ -94,7 +94,7 @@ import java.util.ListIterator;
*
* @see java.util.LinkedList
* @since Commons Collections 1.0
* @version $Revision: 1.2 $ $Date: 2003/12/29 00:38:08 $
* @version $Revision: 1.3 $ $Date: 2004/01/08 22:37:31 $
*
* @author Rodney Waldhoff
* @author Janek Bogucki
@ -103,7 +103,7 @@ import java.util.ListIterator;
*/
public class CursorableLinkedList extends AbstractLinkedList implements Serializable {
/** Ensure serialization compatability */
/** Ensure serialization compatibility */
private static final long serialVersionUID = 8836393098519411393L;
/** A list of the cursor currently open on this list */

6
src/java/org/apache/commons/collections/list/LazyList.java
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/list/LazyList.java,v 1.1 2003/11/16 00:05:47 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/list/LazyList.java,v 1.2 2004/01/08 22:37:31 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -89,7 +89,7 @@ import org.apache.commons.collections.Factory;
* and third element are all set to <code>null</code>.
*
* @since Commons Collections 3.0
* @version $Revision: 1.1 $ $Date: 2003/11/16 00:05:47 $
* @version $Revision: 1.2 $ $Date: 2004/01/08 22:37:31 $
*
* @author Stephen Colebourne
* @author Arron Bates
@ -133,7 +133,7 @@ public class LazyList extends AbstractListDecorator {
* <p>
* If the requested index is greater than the current size, the list will
* grow to the new size and a new object will be returned from the factory.
* Indexes inbetween the old size and the requested size are left with a
* Indexes in-between the old size and the requested size are left with a
* placeholder that is replaced with a factory object when requested.
*
* @param index the index to retrieve

14
src/java/org/apache/commons/collections/map/AbstractHashedMap.java
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/map/AbstractHashedMap.java,v 1.8 2004/01/05 22:04:19 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractHashedMap.java,v 1.9 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -88,7 +88,7 @@ import org.apache.commons.collections.MapIterator;
* need for unusual subclasses is here.
*
* @since Commons Collections 3.0
* @version $Revision: 1.8 $ $Date: 2004/01/05 22:04:19 $
* @version $Revision: 1.9 $ $Date: 2004/01/08 22:37:30 $
*
* @author java util HashMap
* @author Stephen Colebourne
@ -142,13 +142,13 @@ public class AbstractHashedMap implements IterableMap {
*
* @param initialCapacity the initial capacity, must be a power of two
* @param loadFactor the load factor, must be &gt; 0.0f and generally &lt; 1.0f
* @param threshhold the threshold, must be sensible
* @param threshold the threshold, must be sensible
*/
protected AbstractHashedMap(int initialCapacity, float loadFactor, int threshhold) {
protected AbstractHashedMap(int initialCapacity, float loadFactor, int threshold) {
super();
this.loadFactor = loadFactor;
this.data = new HashEntry[initialCapacity];
this.threshold = threshhold;
this.threshold = threshold;
init();
}
@ -693,7 +693,7 @@ public class AbstractHashedMap implements IterableMap {
* A MapIterator returns the keys in the map. It also provides convenient
* methods to get the key and value, and set the value.
* It avoids the need to create an entrySet/keySet/values object.
* It also avoids creating the Mep Entry object.
* It also avoids creating the Map.Entry object.
*
* @return the map iterator
*/
@ -1247,7 +1247,7 @@ public class AbstractHashedMap implements IterableMap {
/**
* Gets the standard Map hashCode.
*
* @return the hashcode defined in the Map interface
* @return the hash code defined in the Map interface
*/
public int hashCode() {
int total = 0;

12
src/java/org/apache/commons/collections/map/AbstractLinkedMap.java
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/map/AbstractLinkedMap.java,v 1.6 2004/01/05 22:04:19 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/AbstractLinkedMap.java,v 1.7 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -98,7 +98,7 @@ import org.apache.commons.collections.ResettableIterator;
* methods exposed.
*
* @since Commons Collections 3.0
* @version $Revision: 1.6 $ $Date: 2004/01/05 22:04:19 $
* @version $Revision: 1.7 $ $Date: 2004/01/08 22:37:30 $
*
* @author java util LinkedHashMap
* @author Stephen Colebourne
@ -120,10 +120,10 @@ public class AbstractLinkedMap extends AbstractHashedMap implements OrderedMap {
*
* @param initialCapacity the initial capacity, must be a power of two
* @param loadFactor the load factor, must be > 0.0f and generally < 1.0f
* @param threshhold the threshold, must be sensible
* @param threshold the threshold, must be sensible
*/
protected AbstractLinkedMap(int initialCapacity, float loadFactor, int threshhold) {
super(initialCapacity, loadFactor, threshhold);
protected AbstractLinkedMap(int initialCapacity, float loadFactor, int threshold) {
super(initialCapacity, loadFactor, threshold);
}
/**
@ -341,7 +341,6 @@ public class AbstractLinkedMap extends AbstractHashedMap implements OrderedMap {
* A MapIterator returns the keys in the map. It also provides convenient
* methods to get the key and value, and set the value.
* It avoids the need to create an entrySet/keySet/values object.
* It also avoids creating the Mep Entry object.
*
* @return the map iterator
*/
@ -359,7 +358,6 @@ public class AbstractLinkedMap extends AbstractHashedMap implements OrderedMap {
* A MapIterator returns the keys in the map. It also provides convenient
* methods to get the key and value, and set the value.
* It avoids the need to create an entrySet/keySet/values object.
* It also avoids creating the Mep Entry object.
*
* @return the map iterator
*/

6
src/java/org/apache/commons/collections/map/CompositeMap.java
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/map/CompositeMap.java,v 1.4 2004/01/05 22:04:19 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/CompositeMap.java,v 1.5 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -74,7 +74,7 @@ import org.apache.commons.collections.set.CompositeSet;
* strategy is provided then add and remove are unsupported.
*
* @since Commons Collections 3.0
* @version $Revision: 1.4 $ $Date: 2004/01/05 22:04:19 $
* @version $Revision: 1.5 $ $Date: 2004/01/08 22:37:30 $
*
* @author Brian McCallister
*/
@ -519,7 +519,7 @@ public class CompositeMap implements Map {
* Called when adding a new Composited Map results in a
* key collision.
*
* @param composite the CompositeMap withthe collision
* @param composite the CompositeMap with the collision
* @param existing the Map already in the composite which contains the
* offending key
* @param added the Map being added

6
src/java/org/apache/commons/collections/map/Flat3Map.java
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/map/Flat3Map.java,v 1.10 2004/01/05 22:04:19 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/Flat3Map.java,v 1.11 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -98,7 +98,7 @@ import org.apache.commons.collections.ResettableIterator;
* Do not use <code>Flat3Map</code> if the size is likely to grow beyond 3.
*
* @since Commons Collections 3.0
* @version $Revision: 1.10 $ $Date: 2004/01/05 22:04:19 $
* @version $Revision: 1.11 $ $Date: 2004/01/08 22:37:30 $
*
* @author Stephen Colebourne
*/
@ -1041,7 +1041,7 @@ public class Flat3Map implements IterableMap {
/**
* Gets the standard Map hashCode.
*
* @return the hashcode defined in the Map interface
* @return the hash code defined in the Map interface
*/
public int hashCode() {
if (delegateMap != null) {

6
src/java/org/apache/commons/collections/map/HashedMap.java
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/map/HashedMap.java,v 1.12 2004/01/05 22:04:19 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/HashedMap.java,v 1.13 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -67,12 +67,12 @@ import java.util.Map;
* A <code>Map</code> implementation that is a general purpose alternative
* to <code>HashMap</code>.
* <p>
* This implementation improves on the JDK1.4 HahMap by adding the
* This implementation improves on the JDK1.4 HashMap by adding the
* {@link org.apache.commons.collections.MapIterator MapIterator}
* functionality and many methods for subclassing.
* <p>
* @since Commons Collections 3.0
* @version $Revision: 1.12 $ $Date: 2004/01/05 22:04:19 $
* @version $Revision: 1.13 $ $Date: 2004/01/08 22:37:30 $
*
* @author Stephen Colebourne
*/

10
src/java/org/apache/commons/collections/map/StaticBucketMap.java
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/map/StaticBucketMap.java,v 1.8 2004/01/05 22:15:14 scolebourne Exp $
* $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//collections/src/java/org/apache/commons/collections/map/StaticBucketMap.java,v 1.9 2004/01/08 22:37:30 scolebourne Exp $
* ====================================================================
*
* The Apache Software License, Version 1.1
@ -76,7 +76,7 @@ import org.apache.commons.collections.KeyValue;
* {@link #remove(Object) remove} and {@link #containsKey(Object) containsKey}
* operations, assuming (approximate) uniform hashing and
* that the number of entries does not exceed the number of buckets. If the
* number of entries exceeds the number of buckets or if the hashcodes of the
* number of entries exceeds the number of buckets or if the hash codes of the
* objects are not uniformly distributed, these operations have a worst case
* scenario that is proportional to the number of elements in the map
* (<i>O(n)</i>).<p>
@ -132,7 +132,7 @@ import org.apache.commons.collections.KeyValue;
* operations will affect the map.<p>
*
* @since Commons Collections 3.0 (previously in main package v2.1)
* @version $Revision: 1.8 $ $Date: 2004/01/05 22:15:14 $
* @version $Revision: 1.9 $ $Date: 2004/01/08 22:37:30 $
*
* @author Berin Loritsch
* @author Gerhard Froehlich
@ -461,9 +461,9 @@ public final class StaticBucketMap implements Map {
}
/**
* Gets the hashcode, as per the Map specification.
* Gets the hash code, as per the Map specification.
*
* @return the hashcode
* @return the hash code
*/
public int hashCode() {
int hashCode = 0;