This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
commit 643039944db847f5162ffa28fe9a9651a6f41fb3
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Sat Apr 19 08:44:49 2025 -0400
Javadoc
---
.../java/org/apache/commons/collections4/Bag.java | 2 +-
.../commons/collections4/CollectionUtils.java | 10 +++---
.../commons/collections4/EnumerationUtils.java | 2 +-
.../commons/collections4/FluentIterable.java | 2 +-
.../apache/commons/collections4/IterableUtils.java | 2 +-
.../org/apache/commons/collections4/MultiSet.java | 6 ++--
.../commons/collections4/MultiValuedMap.java | 2 +-
.../org/apache/commons/collections4/SetUtils.java | 41 +++++++++++++++++++---
.../commons/collections4/bag/AbstractMapBag.java | 8 +++--
.../commons/collections4/bag/CollectionBag.java | 2 +-
.../commons/collections4/bidimap/TreeBidiMap.java | 2 +-
.../bloomfilter/CountingBloomFilter.java | 2 +-
.../collections4/bloomfilter/LayerManager.java | 4 +--
.../comparators/BooleanComparator.java | 4 +--
.../collections4/iterators/CollatingIterator.java | 2 +-
.../iterators/EnumerationIterator.java | 3 +-
.../iterators/IteratorEnumeration.java | 2 +-
.../apache/commons/collections4/list/TreeList.java | 6 ++--
.../commons/collections4/map/CompositeMap.java | 2 +-
.../map/ConcurrentReferenceHashMap.java | 2 +-
.../collections4/map/FixedSizeSortedMap.java | 2 +-
.../multimap/AbstractMultiValuedMap.java | 6 ++--
.../collections4/multiset/AbstractMapMultiSet.java | 10 +++---
.../collections4/multiset/AbstractMultiSet.java | 8 +++--
.../collections4/queue/CircularFifoQueue.java | 2 +-
.../commons/collections4/sequence/EditCommand.java | 2 +-
.../commons/collections4/set/ListOrderedSet.java | 8 ++++-
.../collections4/trie/AbstractBitwiseTrie.java | 2 +-
.../collections4/trie/AbstractPatriciaTrie.java | 10 +++---
29 files changed, 100 insertions(+), 56 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/Bag.java
b/src/main/java/org/apache/commons/collections4/Bag.java
index 4b1b9d39d..b06061a01 100644
--- a/src/main/java/org/apache/commons/collections4/Bag.java
+++ b/src/main/java/org/apache/commons/collections4/Bag.java
@@ -104,7 +104,7 @@ public interface Bag<E> extends Collection<E> {
boolean containsAll(Collection<?> coll);
/**
- * Returns the number of occurrences (cardinality) of the given
+ * Gets the number of occurrences (cardinality) of the given
* object currently in the bag. If the object does not exist in the
* bag, return 0.
*
diff --git a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
index d1e2c2849..4a7313361 100644
--- a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
+++ b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
@@ -965,7 +965,7 @@ public class CollectionUtils {
}
/**
- * Returns the {@code index}-th value in the {@code iterable}'s {@link
Iterator}, throwing
+ * Gets the {@code index}-th value in the {@code iterable}'s {@link
Iterator}, throwing
* {@code IndexOutOfBoundsException} if there is no such element.
* <p>
* If the {@link Iterable} is a {@link List}, then it will use {@link
List#get(int)}.
@@ -985,7 +985,7 @@ public class CollectionUtils {
}
/**
- * Returns the {@code index}-th value in {@link Iterator}, throwing
+ * Gets the {@code index}-th value in {@link Iterator}, throwing
* {@code IndexOutOfBoundsException} if there is no such element.
* <p>
* The Iterator is advanced to {@code index} (or to the end, if
@@ -1008,7 +1008,7 @@ public class CollectionUtils {
}
/**
- * Returns the {@code index}-th {@code Map.Entry} in the {@code map}'s
{@code entrySet},
+ * Gets the {@code index}-th {@code Map.Entry} in the {@code map}'s {@code
entrySet},
* throwing {@code IndexOutOfBoundsException} if there is no such element.
*
* @param <K> the key type in the {@link Map}
@@ -1025,7 +1025,7 @@ public class CollectionUtils {
}
/**
- * Returns the {@code index}-th value in {@code object}, throwing
+ * Gets the {@code index}-th value in {@code object}, throwing
* {@code IndexOutOfBoundsException} if there is no such element or
* {@code IllegalArgumentException} if {@code object} is not an
* instance of one of the supported types.
@@ -1091,7 +1091,7 @@ public class CollectionUtils {
}
/**
- * Returns a {@link Map} mapping each unique element in the given
+ * Gets a {@link Map} mapping each unique element in the given
* {@link Collection} to an {@link Integer} representing the number
* of occurrences of that element in the {@link Collection}.
* <p>
diff --git
a/src/main/java/org/apache/commons/collections4/EnumerationUtils.java
b/src/main/java/org/apache/commons/collections4/EnumerationUtils.java
index 2d8365982..29252eb9b 100644
--- a/src/main/java/org/apache/commons/collections4/EnumerationUtils.java
+++ b/src/main/java/org/apache/commons/collections4/EnumerationUtils.java
@@ -46,7 +46,7 @@ public class EnumerationUtils {
}
/**
- * Returns the {@code index}-th value in the {@link Enumeration}, throwing
+ * Gets the {@code index}-th value in the {@link Enumeration}, throwing
* {@code IndexOutOfBoundsException} if there is no such element.
* <p>
* The Enumeration is advanced to {@code index} (or to the end, if
diff --git a/src/main/java/org/apache/commons/collections4/FluentIterable.java
b/src/main/java/org/apache/commons/collections4/FluentIterable.java
index 6525862a8..65e391403 100644
--- a/src/main/java/org/apache/commons/collections4/FluentIterable.java
+++ b/src/main/java/org/apache/commons/collections4/FluentIterable.java
@@ -326,7 +326,7 @@ public class FluentIterable<E> implements Iterable<E> {
}
/**
- * Returns the element at the provided position in this iterable.
+ * Gets the element at the provided position in this iterable.
* In order to return the element, an iterator needs to be traversed
* up to the requested position.
*
diff --git a/src/main/java/org/apache/commons/collections4/IterableUtils.java
b/src/main/java/org/apache/commons/collections4/IterableUtils.java
index 38a1c11a5..b320c91fd 100644
--- a/src/main/java/org/apache/commons/collections4/IterableUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IterableUtils.java
@@ -547,7 +547,7 @@ public class IterableUtils {
}
/**
- * Returns the {@code index}-th value in the {@code iterable}'s {@link
Iterator}, throwing
+ * Gets the {@code index}-th value in the {@code iterable}'s {@link
Iterator}, throwing
* {@code IndexOutOfBoundsException} if there is no such element.
* <p>
* If the {@link Iterable} is a {@link List}, then it will use {@link
List#get(int)}.
diff --git a/src/main/java/org/apache/commons/collections4/MultiSet.java
b/src/main/java/org/apache/commons/collections4/MultiSet.java
index 122a824ea..2c1c7d80d 100644
--- a/src/main/java/org/apache/commons/collections4/MultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/MultiSet.java
@@ -67,14 +67,14 @@ public interface MultiSet<E> extends Collection<E> {
boolean equals(Object o);
/**
- * Returns the number of occurrences for the element of this entry.
+ * Gets the number of occurrences for the element of this entry.
*
* @return the number of occurrences of the element
*/
int getCount();
/**
- * Returns the element corresponding to this entry.
+ * Gets the element corresponding to this entry.
*
* @return the element corresponding to this entry
*/
@@ -161,7 +161,7 @@ public interface MultiSet<E> extends Collection<E> {
boolean equals(Object obj);
/**
- * Returns the number of occurrences of the given object currently
+ * Gets the number of occurrences of the given object currently
* in the MultiSet. If the object does not exist in the multiset,
* return 0.
*
diff --git a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
index 5b2d49616..2378c8eb7 100644
--- a/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/MultiValuedMap.java
@@ -126,7 +126,7 @@ public interface MultiValuedMap<K, V> {
// Modification operations
/**
- * Returns a view collection of the values associated with the specified
key.
+ * Gets a view collection of the values associated with the specified key.
* <p>
* This method will return an <strong>empty</strong> collection if {@link
#containsKey(Object)}
* returns {@code false}. Changes to the returned collection will update
the underlying
diff --git a/src/main/java/org/apache/commons/collections4/SetUtils.java
b/src/main/java/org/apache/commons/collections4/SetUtils.java
index 1c55c6e53..447edfaba 100644
--- a/src/main/java/org/apache/commons/collections4/SetUtils.java
+++ b/src/main/java/org/apache/commons/collections4/SetUtils.java
@@ -121,6 +121,7 @@ public class SetUtils {
* <p>
* The returned view contains all elements of {@code a} that are not a
member
* of {@code b}.
+ * </p>
*
* @param <E> the generic type that is able to represent the types
contained
* in both input sets.
@@ -154,8 +155,10 @@ public class SetUtils {
* <p>
* The returned view contains all elements of {@code a} and {@code b} that
are
* not a member of the other set.
+ * </p>
* <p>
* This is equivalent to {@code union(difference(a, b), difference(b, a))}.
+ * </p>
*
* @param <E> the generic type that is able to represent the types
contained
* in both input sets.
@@ -208,6 +211,7 @@ public class SetUtils {
/**
* Gets a typed empty unmodifiable Set.
+ *
* @param <E> the element type
* @return an empty Set
*/
@@ -217,6 +221,7 @@ public class SetUtils {
/**
* Gets a typed empty unmodifiable sorted set.
+ *
* @param <E> the element type
* @return an empty sorted Set
*/
@@ -232,6 +237,7 @@ public class SetUtils {
* This method is useful for implementing {@code Set} when you cannot
* extend AbstractSet. The method takes Collection instances to enable
other
* collection types to use the Set implementation algorithm.
+ * </p>
*
* @param <T> the element type
* @see java.util.Set#hashCode()
@@ -255,6 +261,7 @@ public class SetUtils {
/**
* Creates a set from the given items. If the passed var-args argument is
{@code
* null}, then the method returns {@code null}.
+ *
* @param <E> the element type
* @param items the elements that make up the new set
* @return a set
@@ -272,6 +279,7 @@ public class SetUtils {
* <p>
* The returned view contains all elements that are members of both input
sets
* ({@code a} and {@code b}).
+ * </p>
*
* @param <E> the generic type that is able to represent the types
contained
* in both input sets.
@@ -304,20 +312,23 @@ public class SetUtils {
* This method is useful for implementing {@code Set} when you cannot
* extend AbstractSet. The method takes Collection instances to enable
other
* collection types to use the Set implementation algorithm.
+ * </p>
* <p>
* The relevant text (slightly paraphrased as this is a static method) is:
+ * </p>
* <blockquote>
* <p>Two sets are considered equal if they have
* the same size, and every member of the first set is contained in
* the second. This ensures that the {@code equals} method works
* properly across different implementations of the {@code Set}
- * interface.</p>
- *
+ * interface.
+ * </p>
* <p>
* This implementation first checks if the two sets are the same object:
* if so it returns {@code true}. Then, it checks if the two sets are
* identical in size; if not, it returns false. If so, it returns
- * {@code a.containsAll((Collection) b)}.</p>
+ * {@code a.containsAll((Collection) b)}.
+ * </p>
* </blockquote>
*
* @see java.util.Set
@@ -344,12 +355,14 @@ public class SetUtils {
* As a general rule, don't compare this set to other sets. In particular,
you can't
* use decorators like {@link ListOrderedSet} on it, which silently assume
that these
* contracts are fulfilled.
+ * </p>
* <p>
* <strong>Note that the returned set is not synchronized and is not
thread-safe.</strong>
* If you wish to use this set from multiple threads concurrently, you
must use
* appropriate synchronization. The simplest approach is to wrap this map
* using {@link java.util.Collections#synchronizedSet(Set)}. This class
may throw
* exceptions when accessed by concurrent threads without synchronization.
+ * </p>
*
* @param <E> the element type
* @return a new identity hash set
@@ -365,6 +378,7 @@ public class SetUtils {
* <p>
* If an element is added twice, the order is determined by the first add.
* The order is observed through the iterator or toArray.
+ * </p>
*
* @param <E> the element type
* @param set the set to order, must not be null
@@ -382,6 +396,7 @@ public class SetUtils {
* Trying to add an invalid object results in an IllegalArgumentException.
* It is important not to use the original set after invoking this method,
* as it is a backdoor for adding invalid objects.
+ * </p>
*
* @param <E> the element type
* @param set the navigable set to predicate, must not be null
@@ -402,6 +417,7 @@ public class SetUtils {
* Trying to add an invalid object results in an IllegalArgumentException.
* It is important not to use the original set after invoking this method,
* as it is a backdoor for adding invalid objects.
+ * </p>
*
* @param <E> the element type
* @param set the set to predicate, must not be null
@@ -420,6 +436,7 @@ public class SetUtils {
* Trying to add an invalid object results in an IllegalArgumentException.
* It is important not to use the original set after invoking this method,
* as it is a backdoor for adding invalid objects.
+ * </p>
*
* @param <E> the element type
* @param set the sorted set to predicate, must not be null
@@ -432,12 +449,12 @@ public class SetUtils {
return PredicatedSortedSet.predicatedSortedSet(set, predicate);
}
- // Set
/**
* Returns a synchronized set backed by the given set.
* <p>
* You must manually synchronize on the returned set's iterator to
* avoid non-deterministic behavior:
+ * </p>
*
* <pre>
* Sets s = SetUtils.synchronizedSet(mySet);
@@ -449,7 +466,9 @@ public class SetUtils {
* }
* </pre>
*
+ * <p>
* This method is just a wrapper for {@link
Collections#synchronizedSet(Set)}.
+ * </p>
*
* @param <E> the element type
* @param set the set to synchronize, must not be null
@@ -466,6 +485,7 @@ public class SetUtils {
* <p>
* You must manually synchronize on the returned set's iterator to
* avoid non-deterministic behavior:
+ * </p>
*
* <pre>
* Set s = SetUtils.synchronizedSortedSet(mySet);
@@ -477,7 +497,9 @@ public class SetUtils {
* }
* </pre>
*
+ * <p>
* This method is just a wrapper for {@link
Collections#synchronizedSortedSet(SortedSet)}.
+ * </p>
*
* @param <E> the element type
* @param set the sorted set to synchronize, must not be null
@@ -494,9 +516,11 @@ public class SetUtils {
* Each object is passed through the transformer as it is added to the
* Set. It is important not to use the original set after invoking this
* method, as it is a backdoor for adding untransformed objects.
+ * </p>
* <p>
* Existing entries in the specified set will not be transformed.
* If you want that behavior, see {@link
TransformedNavigableSet#transformedNavigableSet}.
+ * </p>
*
* @param <E> the element type
* @param set the navigable set to transform, must not be null
@@ -516,9 +540,11 @@ public class SetUtils {
* Each object is passed through the transformer as it is added to the
* Set. It is important not to use the original set after invoking this
* method, as it is a backdoor for adding untransformed objects.
+ * </p>
* <p>
* Existing entries in the specified set will not be transformed.
* If you want that behavior, see {@link TransformedSet#transformedSet}.
+ * </p>
*
* @param <E> the element type
* @param set the set to transform, must not be null
@@ -537,9 +563,11 @@ public class SetUtils {
* Each object is passed through the transformer as it is added to the
* Set. It is important not to use the original set after invoking this
* method, as it is a backdoor for adding untransformed objects.
+ * </p>
* <p>
* Existing entries in the specified set will not be transformed.
* If you want that behavior, see {@link
TransformedSortedSet#transformedSortedSet}.
+ * </p>
*
* @param <E> the element type
* @param set the set to transform, must not be null
@@ -558,6 +586,7 @@ public class SetUtils {
* Returns an unmodifiable <strong>view</strong> of the union of the given
{@link Set}s.
* <p>
* The returned view contains all elements of {@code a} and {@code b}.
+ * </p>
*
* @param <E> the generic type that is able to represent the types
contained
* in both input sets.
@@ -596,11 +625,11 @@ public class SetUtils {
};
}
- // NavigableSet
/**
* Returns an unmodifiable navigable set backed by the given navigable set.
* <p>
* This method uses the implementation in the decorators subpackage.
+ * </p>
*
* @param <E> the element type
* @param set the navigable set to make unmodifiable, must not be null
@@ -631,6 +660,7 @@ public class SetUtils {
* Returns an unmodifiable set backed by the given set.
* <p>
* This method uses the implementation in the decorators subpackage.
+ * </p>
*
* @param <E> the element type
* @param set the set to make unmodifiable, must not be null
@@ -645,6 +675,7 @@ public class SetUtils {
* Returns an unmodifiable sorted set backed by the given sorted set.
* <p>
* This method uses the implementation in the decorators subpackage.
+ * </p>
*
* @param <E> the element type
* @param set the sorted set to make unmodifiable, must not be null
diff --git
a/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java
b/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java
index 891b12e1c..9da508f62 100644
--- a/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java
+++ b/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java
@@ -283,7 +283,8 @@ public abstract class AbstractMapBag<E> implements Bag<E> {
}
/**
- * Read the map in using a custom routine.
+ * Reads the map in using a custom routine.
+ *
* @param map the map to use
* @param in the input stream
* @throws IOException any of the usual I/O related exceptions
@@ -304,7 +305,8 @@ public abstract class AbstractMapBag<E> implements Bag<E> {
}
/**
- * Write the map out using a custom routine.
+ * Writes the map out using a custom routine.
+ *
* @param out the output stream
* @throws IOException any of the usual I/O related exceptions
*/
@@ -344,7 +346,7 @@ public abstract class AbstractMapBag<E> implements Bag<E> {
}
/**
- * Returns the number of occurrence of the given element in this bag by
+ * Gets the number of occurrence of the given element in this bag by
* looking up its count in the underlying map.
*
* @param object the object to search for
diff --git
a/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java
b/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java
index c8b4c86d8..4e25590ea 100644
--- a/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java
+++ b/src/main/java/org/apache/commons/collections4/bag/CollectionBag.java
@@ -125,7 +125,7 @@ public final class CollectionBag<E> extends
AbstractBagDecorator<E> {
}
/**
- * Read the collection in using a custom routine.
+ * Reads the collection in using a custom routine.
*
* @param in the input stream
* @throws IOException if an error occurs while reading from the stream
diff --git
a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
index fc6b10512..167cc8b36 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
@@ -1530,7 +1530,7 @@ public class TreeBidiMap<K extends Comparable<K>, V
extends Comparable<V>>
}
/**
- * Returns the key to which this map maps the specified value.
+ * Gets the key to which this map maps the specified value.
* Returns null if the map contains no mapping for this value.
* <p>
* The value must implement {@code Comparable}.
diff --git
a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java
b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java
index acd6c94e3..a8bb7e8f1 100644
---
a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java
+++
b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java
@@ -75,7 +75,7 @@ public interface CountingBloomFilter extends
BloomFilter<CountingBloomFilter>, C
boolean add(CellExtractor other);
/**
- * Returns the maximum allowable value for a cell count in this Counting
filter.
+ * Gets the maximum allowable value for a cell count in this Counting
filter.
*
* @return the maximum allowable value for a cell count in this Counting
filter.
*/
diff --git
a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
index a3856f28d..d6111c5dc 100644
---
a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
+++
b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
@@ -385,7 +385,7 @@ public class LayerManager<T extends BloomFilter<T>>
implements BloomFilterExtrac
}
/**
- * Returns the number of filters in the LayerManager. In the default
LayerManager implementation
+ * Gets the number of filters in the LayerManager. In the default
LayerManager implementation
* there is always at least one layer.
*
* @return the current depth.
@@ -395,7 +395,7 @@ public class LayerManager<T extends BloomFilter<T>>
implements BloomFilterExtrac
}
/**
- * Returns the current target filter. If a new filter should be created
based on
+ * Gets the current target filter. If a new filter should be created based
on
* {@code extendCheck} it will be created before this method returns.
*
* @return the current target filter after any extension.
diff --git
a/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java
b/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java
index 2f9518ad0..83c61c05e 100644
---
a/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java
+++
b/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java
@@ -61,7 +61,7 @@ public final class BooleanComparator implements
Comparator<Boolean>, Serializabl
}
/**
- * Returns a BooleanComparator instance that sorts
+ * Gets a BooleanComparator instance that sorts
* {@code false} values before {@code true} values.
* <p>
* Clients are encouraged to use the value returned from
@@ -78,7 +78,7 @@ public final class BooleanComparator implements
Comparator<Boolean>, Serializabl
}
/**
- * Returns a BooleanComparator instance that sorts
+ * Gets a BooleanComparator instance that sorts
* {@code true} values before {@code false} values.
* <p>
* Clients are encouraged to use the value returned from
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java
index 31ea9d52d..54c1c2060 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java
@@ -222,7 +222,7 @@ public class CollatingIterator<E> implements Iterator<E> {
}
/**
- * Returns the index of the iterator that returned the last element.
+ * Gets the index of the iterator that returned the last element.
*
* @return the index of the iterator that returned the last element
* @throws IllegalStateException if there is no last returned element
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java
index 0e3fa8408..7bc1f51fa 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java
@@ -68,9 +68,8 @@ public class EnumerationIterator<E> implements Iterator<E> {
this.last = null;
}
- // Properties
/**
- * Returns the underlying enumeration.
+ * Gets the underlying enumeration.
*
* @return the underlying enumeration
*/
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/IteratorEnumeration.java
b/src/main/java/org/apache/commons/collections4/iterators/IteratorEnumeration.java
index e7bd0d60d..c53c54b7e 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/IteratorEnumeration.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/IteratorEnumeration.java
@@ -49,7 +49,7 @@ public class IteratorEnumeration<E> implements Enumeration<E>
{
}
/**
- * Returns the underlying iterator.
+ * Gets the underlying iterator.
*
* @return the underlying iterator
*/
diff --git a/src/main/java/org/apache/commons/collections4/list/TreeList.java
b/src/main/java/org/apache/commons/collections4/list/TreeList.java
index d91297b26..195018acc 100644
--- a/src/main/java/org/apache/commons/collections4/list/TreeList.java
+++ b/src/main/java/org/apache/commons/collections4/list/TreeList.java
@@ -297,7 +297,7 @@ public class TreeList<E> extends AbstractList<E> {
}
/**
- * Locate the element with the given index relative to the
+ * Gets the element with the given index relative to the
* offset of the parent of this node.
*/
AVLNode<E> get(final int index) {
@@ -315,7 +315,7 @@ public class TreeList<E> extends AbstractList<E> {
}
/**
- * Returns the height of the node or -1 if the node is null.
+ * Gets the height of the node or -1 if the node is null.
*/
private int getHeight(final AVLNode<E> node) {
return node == null ? -1 : node.height;
@@ -362,7 +362,7 @@ public class TreeList<E> extends AbstractList<E> {
}
/**
- * Locate the index that contains the specified object.
+ * Finds the index that contains the specified object.
*/
int indexOf(final Object object, final int index) {
if (getLeftSubTree() != null) {
diff --git
a/src/main/java/org/apache/commons/collections4/map/CompositeMap.java
b/src/main/java/org/apache/commons/collections4/map/CompositeMap.java
index 115ab7a02..885d32042 100644
--- a/src/main/java/org/apache/commons/collections4/map/CompositeMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/CompositeMap.java
@@ -313,7 +313,7 @@ public class CompositeMap<K, V> extends
AbstractIterableMap<K, V> implements Ser
}
/**
- * Returns the value to which this map maps the specified key. Returns
+ * Gets the value to which this map maps the specified key. Returns
* {@code null} if the map contains no mapping for this key. A return
* value of {@code null} does not <em>necessarily</em> indicate that the
* map contains no mapping for the key; it's also possible that the map
diff --git
a/src/main/java/org/apache/commons/collections4/map/ConcurrentReferenceHashMap.java
b/src/main/java/org/apache/commons/collections4/map/ConcurrentReferenceHashMap.java
index d76a125d5..f4c0821bf 100644
---
a/src/main/java/org/apache/commons/collections4/map/ConcurrentReferenceHashMap.java
+++
b/src/main/java/org/apache/commons/collections4/map/ConcurrentReferenceHashMap.java
@@ -1624,7 +1624,7 @@ public class ConcurrentReferenceHashMap<K, V> extends
AbstractMap<K, V> implemen
}
/**
- * Returns the value to which the specified key is mapped, or {@code null}
if this map contains no mapping for the key.
+ * Gets the value to which the specified key is mapped, or {@code null} if
this map contains no mapping for the key.
* <p>
* If this map contains a mapping from a key {@code k} to a value {@code
v} such that {@code key.equals(k)}, then this method returns {@code v};
otherwise
* it returns {@code null}. (There can be at most one such mapping.)
diff --git
a/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java
b/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java
index e358b164e..86b7eaca5 100644
--- a/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/FixedSizeSortedMap.java
@@ -179,7 +179,7 @@ public class FixedSizeSortedMap<K, V>
}
/**
- * Write the map out using a custom routine.
+ * Writes the map out using a custom routine.
*
* @param out the output stream
* @throws IOException if an error occurs while writing to the stream
diff --git
a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
index 3ce1592f3..4f3cf6d67 100644
---
a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
+++
b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
@@ -626,7 +626,8 @@ public abstract class AbstractMultiValuedMap<K, V>
implements MultiValuedMap<K,
protected abstract Collection<V> createCollection();
/**
- * Read the map in using a custom routine.
+ * Reads the map in using a custom routine.
+ *
* @param in the input stream
* @throws IOException any of the usual I/O related exceptions
* @throws ClassNotFoundException if the stream contains an object which
class cannot be loaded
@@ -649,7 +650,8 @@ public abstract class AbstractMultiValuedMap<K, V>
implements MultiValuedMap<K,
}
/**
- * Write the map out using a custom routine.
+ * Writes the map out using a custom routine.
+ *
* @param out the output stream
* @throws IOException any of the usual I/O related exceptions
*/
diff --git
a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
index d896e251c..dd8608325 100644
---
a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
+++
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
@@ -345,7 +345,8 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
}
/**
- * Read the multiset in using a custom routine.
+ * Reads the multiset in using a custom routine.
+ *
* @param in the input stream
* @throws IOException any of the usual I/O related exceptions
* @throws ClassNotFoundException if the stream contains an object which
class cannot be loaded
@@ -365,7 +366,8 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
}
/**
- * Write the multiset out using a custom routine.
+ * Writes the multiset out using a custom routine.
+ *
* @param out the output stream
* @throws IOException any of the usual I/O related exceptions
*/
@@ -399,7 +401,7 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
}
/**
- * Returns the number of occurrence of the given element in this multiset
by
+ * Gets the number of occurrence of the given element in this multiset by
* looking up its count in the underlying map.
*
* @param object the object to search for
@@ -415,7 +417,7 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
}
/**
- * Utility method for implementations to access the map that backs this
multiset.
+ * Gets the map that backs this multiset.
* Not intended for interactive use outside of subclasses.
*
* @return the map being used by the MultiSet
diff --git
a/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
index 1a47ff154..204a7ef49 100644
---
a/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
+++
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java
@@ -324,7 +324,8 @@ public abstract class AbstractMultiSet<E> extends
AbstractCollection<E> implemen
}
/**
- * Read the multiset in using a custom routine.
+ * Reads the multiset in using a custom routine.
+ *
* @param in the input stream
* @throws IOException any of the usual I/O related exceptions
* @throws ClassNotFoundException if the stream contains an object which
class cannot be loaded
@@ -342,7 +343,8 @@ public abstract class AbstractMultiSet<E> extends
AbstractCollection<E> implemen
}
/**
- * Write the multiset out using a custom routine.
+ * Writes the multiset out using a custom routine.
+ *
* @param out the output stream
* @throws IOException any of the usual I/O related exceptions
*/
@@ -388,7 +390,7 @@ public abstract class AbstractMultiSet<E> extends
AbstractCollection<E> implemen
}
/**
- * Returns the number of occurrence of the given element in this multiset
by
+ * Gets the number of occurrence of the given element in this multiset by
* iterating over its entrySet.
*
* @param object the object to search for
diff --git
a/src/main/java/org/apache/commons/collections4/queue/CircularFifoQueue.java
b/src/main/java/org/apache/commons/collections4/queue/CircularFifoQueue.java
index afc957f88..5109b5754 100644
--- a/src/main/java/org/apache/commons/collections4/queue/CircularFifoQueue.java
+++ b/src/main/java/org/apache/commons/collections4/queue/CircularFifoQueue.java
@@ -174,7 +174,7 @@ public class CircularFifoQueue<E> extends
AbstractCollection<E>
}
/**
- * Returns the element at the specified position in this queue.
+ * Gets the element at the specified position in this queue.
*
* @param index the position of the element in the queue
* @return the element at position {@code index}
diff --git
a/src/main/java/org/apache/commons/collections4/sequence/EditCommand.java
b/src/main/java/org/apache/commons/collections4/sequence/EditCommand.java
index f32c029d2..a40f5df6c 100644
--- a/src/main/java/org/apache/commons/collections4/sequence/EditCommand.java
+++ b/src/main/java/org/apache/commons/collections4/sequence/EditCommand.java
@@ -72,7 +72,7 @@ public abstract class EditCommand<T> {
public abstract void accept(CommandVisitor<T> visitor);
/**
- * Returns the object associated with this command.
+ * Gets the object associated with this command.
*
* @return the object on which the command is applied
*/
diff --git
a/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
b/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
index 57c5ee02a..f6000520d 100644
--- a/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/ListOrderedSet.java
@@ -110,9 +110,11 @@ public class ListOrderedSet<E>
* Factory method to create an ordered set using the supplied list to
retain order.
* <p>
* A {@code HashSet} is used for the set behavior.
+ * </p>
* <p>
* NOTE: If the list contains duplicates, the duplicates are removed,
* altering the specified list.
+ * </p>
*
* @param <E> the element type
* @param list the list to decorate, must not be null
@@ -132,6 +134,7 @@ public class ListOrderedSet<E>
* Factory method to create an ordered set.
* <p>
* An {@code ArrayList} is used to retain order.
+ * </p>
*
* @param <E> the element type
* @param set the set to decorate, must not be null
@@ -147,6 +150,7 @@ public class ListOrderedSet<E>
* Factory method to create an ordered set specifying the list and set to
use.
* <p>
* The list and set must both be empty.
+ * </p>
*
* @param <E> the element type
* @param set the set to decorate, must be empty and not null
@@ -195,6 +199,7 @@ public class ListOrderedSet<E>
* use.
* <p>
* The set and list must both be correctly initialized to the same
elements.
+ * </p>
*
* @param set the set to decorate, must not be null
* @param list the list to decorate, must not be null
@@ -286,7 +291,7 @@ public class ListOrderedSet<E>
}
/**
- * Returns the element at the specified position in this ordered set.
+ * Gets the element at the specified position in this ordered set.
*
* @param index the position of the element in the ordered {@link Set}.
* @return the element at position {@code index}
@@ -369,6 +374,7 @@ public class ListOrderedSet<E>
* If it's not contained, it's removed from this set. As a consequence,
* it is advised to use a collection type for {@code coll} that provides
* a fast (for example O(1)) implementation of {@link
Collection#contains(Object)}.
+ * </p>
*/
@Override
public boolean retainAll(final Collection<?> coll) {
diff --git
a/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java
b/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java
index 5d3a4dd60..a7f4535db 100644
---
a/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java
+++
b/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java
@@ -183,7 +183,7 @@ public abstract class AbstractBitwiseTrie<K, V> extends
AbstractMap<K, V>
}
/**
- * Returns the {@link KeyAnalyzer} that constructed the {@link Trie}.
+ * Gets the {@link KeyAnalyzer} that constructed the {@link Trie}.
* @return the {@link KeyAnalyzer} used by this {@link Trie}
*/
protected KeyAnalyzer<? super K> getKeyAnalyzer() {
diff --git
a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
index ccd89d5c7..dfef9b462 100644
---
a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
+++
b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
@@ -98,12 +98,12 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
}
/**
- * Returns the FROM Key.
+ * Gets the FROM Key.
*/
protected abstract K getFromKey();
/**
- * Returns the TO Key.
+ * Gets the TO Key.
*/
protected abstract K getToKey();
@@ -1545,7 +1545,7 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
}
/**
- * Returns the entry associated with the specified key in the
+ * Gets the entry associated with the specified key in the
* PatriciaTrieBase. Returns null if the map contains no mapping
* for this key.
* <p>
@@ -1563,7 +1563,7 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
}
/**
- * Returns the nearest entry for a given key. This is useful
+ * Gets the nearest entry for a given key. This is useful
* for finding knowing if a given key exists (and finding the value
* for it), or for inserting the key.
*
@@ -1589,7 +1589,7 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
}
/**
- * Returns a view of this {@link org.apache.commons.collections4.Trie} of
all elements that are prefixed
+ * Gets a view of this {@link org.apache.commons.collections4.Trie} of all
elements that are prefixed
* by the number of bits in the given Key.
* <p>
* The view that this returns is optimized to have a very efficient
