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
The following commit(s) were added to refs/heads/master by this push:
new 879d27497 Javadoc: Empty Javadoc line before the 1st tag.
879d27497 is described below
commit 879d274971eceb8aace62f44ce6201516ac53038
Author: Gary Gregory <[email protected]>
AuthorDate: Wed Dec 31 17:41:48 2025 -0500
Javadoc: Empty Javadoc line before the 1st tag.
---
.../java/org/apache/commons/collections4/CollectionUtils.java | 6 ++++++
.../java/org/apache/commons/collections4/FluentIterable.java | 1 +
.../java/org/apache/commons/collections4/IteratorUtils.java | 1 +
src/main/java/org/apache/commons/collections4/ListUtils.java | 1 +
src/main/java/org/apache/commons/collections4/SetUtils.java | 2 ++
.../java/org/apache/commons/collections4/SortedBidiMap.java | 1 +
.../apache/commons/collections4/bag/AbstractBagDecorator.java | 1 +
.../org/apache/commons/collections4/bag/AbstractMapBag.java | 2 ++
.../commons/collections4/bag/AbstractSortedBagDecorator.java | 1 +
.../org/apache/commons/collections4/bag/SynchronizedBag.java | 1 +
.../commons/collections4/bidimap/AbstractDualBidiMap.java | 5 +++++
.../apache/commons/collections4/bidimap/DualTreeBidiMap.java | 2 ++
.../org/apache/commons/collections4/bidimap/TreeBidiMap.java | 2 ++
.../commons/collections4/bloomfilter/BitMapExtractor.java | 1 +
.../apache/commons/collections4/bloomfilter/BloomFilter.java | 1 +
.../commons/collections4/bloomfilter/CountingBloomFilter.java | 2 ++
.../apache/commons/collections4/bloomfilter/IndexFilter.java | 3 +++
.../apache/commons/collections4/bloomfilter/LayerManager.java | 1 +
.../collections4/collection/AbstractCollectionDecorator.java | 1 +
.../commons/collections4/collection/CompositeCollection.java | 11 +++++++++++
.../commons/collections4/iterators/BoundedIterator.java | 1 +
.../commons/collections4/iterators/EmptyMapIterator.java | 2 ++
.../collections4/iterators/EmptyOrderedMapIterator.java | 2 ++
.../commons/collections4/iterators/FilterListIterator.java | 2 ++
.../commons/collections4/iterators/PermutationIterator.java | 3 +++
.../commons/collections4/iterators/SingletonListIterator.java | 1 +
.../org/apache/commons/collections4/keyvalue/MultiKey.java | 2 ++
.../commons/collections4/list/AbstractListDecorator.java | 1 +
.../apache/commons/collections4/map/AbstractMapDecorator.java | 1 +
.../commons/collections4/map/AbstractOrderedMapDecorator.java | 1 +
.../apache/commons/collections4/map/AbstractReferenceMap.java | 2 ++
.../commons/collections4/map/AbstractSortedMapDecorator.java | 2 ++
.../collections4/map/EntrySetToMapIteratorAdapter.java | 2 ++
.../commons/collections4/multimap/AbstractListValuedMap.java | 1 +
.../commons/collections4/multimap/AbstractSetValuedMap.java | 1 +
.../commons/collections4/multiset/AbstractMapMultiSet.java | 4 ++++
.../commons/collections4/multiset/SynchronizedMultiSet.java | 1 +
.../apache/commons/collections4/set/AbstractSetDecorator.java | 1 +
.../commons/collections4/set/AbstractSortedSetDecorator.java | 1 +
.../org/apache/commons/collections4/set/CompositeSet.java | 3 +++
.../splitmap/AbstractIterableGetMapDecorator.java | 2 ++
.../apache/commons/collections4/trie/AbstractBitwiseTrie.java | 1 +
.../commons/collections4/trie/analyzer/StringKeyAnalyzer.java | 1 +
43 files changed, 84 insertions(+)
diff --git a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
index 2ba14cc76..9cc1b80e6 100644
--- a/src/main/java/org/apache/commons/collections4/CollectionUtils.java
+++ b/src/main/java/org/apache/commons/collections4/CollectionUtils.java
@@ -58,6 +58,7 @@ public class CollectionUtils {
/**
* Helper class to easily access cardinality properties of two collections.
+ *
* @param <O> the element type
*/
private static class CardinalityHelper<O> {
@@ -169,6 +170,7 @@ public class CollectionUtils {
/**
* Helper class for set-related operations, for example union, subtract,
intersection.
+ *
* @param <O> the element type
*/
private static final class SetOperationCardinalityHelper<O> extends
CardinalityHelper<O> implements Iterable<O> {
@@ -181,6 +183,7 @@ public class CollectionUtils {
/**
* Create a new set operation helper from the two collections.
+ *
* @param a the first collection
* @param b the second collection
*/
@@ -200,6 +203,7 @@ public class CollectionUtils {
/**
* Returns the resulting collection.
+ *
* @return the result
*/
public Collection<O> list() {
@@ -208,6 +212,7 @@ public class CollectionUtils {
/**
* Add the object {@code count} times to the result collection.
+ *
* @param obj the object to add
* @param count the count
*/
@@ -373,6 +378,7 @@ public class CollectionUtils {
/**
* Ensures an index is not negative.
+ *
* @param index the index to check.
* @throws IndexOutOfBoundsException if the index is negative.
*/
diff --git a/src/main/java/org/apache/commons/collections4/FluentIterable.java
b/src/main/java/org/apache/commons/collections4/FluentIterable.java
index e58ad1e28..77523d359 100644
--- a/src/main/java/org/apache/commons/collections4/FluentIterable.java
+++ b/src/main/java/org/apache/commons/collections4/FluentIterable.java
@@ -138,6 +138,7 @@ public class FluentIterable<E> implements Iterable<E> {
/**
* Create a new FluentIterable by wrapping the provided iterable.
+ *
* @param iterable the iterable to wrap
*/
private FluentIterable(final Iterable<E> iterable) {
diff --git a/src/main/java/org/apache/commons/collections4/IteratorUtils.java
b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
index 41858a7af..cf27afb19 100644
--- a/src/main/java/org/apache/commons/collections4/IteratorUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IteratorUtils.java
@@ -759,6 +759,7 @@ public class IteratorUtils {
* The Iterator is advanced to {@code 0} (or to the end, if
* {@code 0} exceeds the number of entries) as a side effect of this
method.
* </p>
+ *
* @param <E> the type of object in the {@link Iterator}
* @param iterator the iterator to get a value from
* @return the first object
diff --git a/src/main/java/org/apache/commons/collections4/ListUtils.java
b/src/main/java/org/apache/commons/collections4/ListUtils.java
index 1fb90acc6..7d658cb43 100644
--- a/src/main/java/org/apache/commons/collections4/ListUtils.java
+++ b/src/main/java/org/apache/commons/collections4/ListUtils.java
@@ -96,6 +96,7 @@ public class ListUtils {
/**
* Provides a partition view on a {@link List}.
+ *
* @since 4.0
*/
private static final class Partition<T> extends AbstractList<List<T>> {
diff --git a/src/main/java/org/apache/commons/collections4/SetUtils.java
b/src/main/java/org/apache/commons/collections4/SetUtils.java
index bc375cfe4..a6029f9d1 100644
--- a/src/main/java/org/apache/commons/collections4/SetUtils.java
+++ b/src/main/java/org/apache/commons/collections4/SetUtils.java
@@ -81,6 +81,7 @@ public class SetUtils {
/**
* Return an iterator for this view; the returned iterator is
* not required to be unmodifiable.
+ *
* @return a new iterator for this view
*/
protected abstract Iterator<E> createIterator();
@@ -644,6 +645,7 @@ public class SetUtils {
/**
* Creates an unmodifiable 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
diff --git a/src/main/java/org/apache/commons/collections4/SortedBidiMap.java
b/src/main/java/org/apache/commons/collections4/SortedBidiMap.java
index 5d175aaf0..72cd7e779 100644
--- a/src/main/java/org/apache/commons/collections4/SortedBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/SortedBidiMap.java
@@ -56,6 +56,7 @@ public interface SortedBidiMap<K, V> extends
OrderedBidiMap<K, V>, SortedMap<K,
/**
* Gets the comparator used for the values in the value-to-key map aspect.
+ *
* @return Comparator<? super V>
*/
Comparator<? super V> valueComparator();
diff --git
a/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java
b/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java
index ea94dd201..a932fcff2 100644
---
a/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/bag/AbstractBagDecorator.java
@@ -38,6 +38,7 @@ public abstract class AbstractBagDecorator<E>
/**
* Constructor only used in deserialization, do not use otherwise.
+ *
* @since 3.1
*/
protected AbstractBagDecorator() {
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 4619afc92..f64d19c93 100644
--- a/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java
+++ b/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java
@@ -121,6 +121,7 @@ public abstract class AbstractMapBag<E> implements Bag<E> {
/**
* Constructs a new instance.
+ *
* @param value the initial value
*/
MutableInteger(final int value) {
@@ -479,6 +480,7 @@ public abstract class AbstractMapBag<E> implements Bag<E> {
/**
* Remove any members of the bag that are not in the given bag, respecting
* cardinality.
+ *
* @see #retainAll(Collection)
* @param other the bag to retain
* @return {@code true} if this call changed the collection
diff --git
a/src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java
b/src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java
index d73a5569b..723fc65f9 100644
---
a/src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/bag/AbstractSortedBagDecorator.java
@@ -37,6 +37,7 @@ public abstract class AbstractSortedBagDecorator<E>
/**
* Constructor only used in deserialization, do not use otherwise.
+ *
* @since 3.1
*/
protected AbstractSortedBagDecorator() {
diff --git
a/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java
b/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java
index 1313f1cc6..5990e1a83 100644
--- a/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java
+++ b/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java
@@ -46,6 +46,7 @@ public class SynchronizedBag<E> extends
SynchronizedCollection<E> implements Bag
/**
* Constructs a new instance.
+ *
* @param set the set to decorate
* @param lock the lock to use, shared with the bag
*/
diff --git
a/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java
b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java
index 67c20c236..f22501b84 100644
---
a/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java
+++
b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java
@@ -67,6 +67,7 @@ public abstract class AbstractDualBidiMap<K, V> implements
BidiMap<K, V> {
/**
* Constructs a new instance.
+ *
* @param parent the parent map
*/
protected BidiMapIterator(final AbstractDualBidiMap<K, V> parent) {
@@ -210,6 +211,7 @@ public abstract class AbstractDualBidiMap<K, V> implements
BidiMap<K, V> {
/**
* Constructs a new instance.
+ *
* @param iterator the iterator to decorate
* @param parent the parent map
*/
@@ -298,6 +300,7 @@ public abstract class AbstractDualBidiMap<K, V> implements
BidiMap<K, V> {
/**
* Constructs a new instance.
+ *
* @param iterator the iterator to decorate
* @param parent the parent map
*/
@@ -339,6 +342,7 @@ public abstract class AbstractDualBidiMap<K, V> implements
BidiMap<K, V> {
/**
* Constructs a new instance.
+ *
* @param entry the entry to decorate
* @param parent the parent map
*/
@@ -419,6 +423,7 @@ public abstract class AbstractDualBidiMap<K, V> implements
BidiMap<K, V> {
/**
* Constructs a new instance.
+ *
* @param iterator the iterator to decorate
* @param parent the parent map
*/
diff --git
a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java
b/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java
index f539081ca..e897be87b 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java
@@ -78,6 +78,7 @@ public class DualTreeBidiMap<K, V> extends
AbstractDualBidiMap<K, V>
/**
* Constructs a new instance.
+ *
* @param parent the parent map
*/
protected BidiOrderedMapIterator(final AbstractDualBidiMap<K, V>
parent) {
@@ -174,6 +175,7 @@ public class DualTreeBidiMap<K, V> extends
AbstractDualBidiMap<K, V>
protected static class ViewMap<K, V> extends AbstractSortedMapDecorator<K,
V> {
/**
* Constructs a new instance.
+ *
* @param bidi the parent bidi map
* @param sm the subMap sorted map
*/
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 c7ed23ff9..2524c11a9 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
@@ -95,6 +95,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends
Comparable<V>>
/**
* Constructs a new instance.
+ *
* @param orderType the KEY or VALUE int for the order
*/
AbstractView(final DataElement orderType) {
@@ -130,6 +131,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends
Comparable<V>>
/**
* Constructs a new instance.
+ *
* @param orderType the KEY or VALUE int for the order
*/
AbstractViewIterator(final DataElement orderType) {
diff --git
a/src/main/java/org/apache/commons/collections4/bloomfilter/BitMapExtractor.java
b/src/main/java/org/apache/commons/collections4/bloomfilter/BitMapExtractor.java
index 886a43057..fcb101e75 100644
---
a/src/main/java/org/apache/commons/collections4/bloomfilter/BitMapExtractor.java
+++
b/src/main/java/org/apache/commons/collections4/bloomfilter/BitMapExtractor.java
@@ -94,6 +94,7 @@ public interface BitMapExtractor {
* The default implementation of this method is slow. It is recommended
* that implementing classes reimplement this method.
* </p>
+ *
* @return An array of bit map data.
*/
default long[] asBitMapArray() {
diff --git
a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
index 7f89b26e9..b006e5317 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
@@ -232,6 +232,7 @@ public interface BloomFilter<T extends BloomFilter<T>>
extends IndexExtractor, B
/**
* Gets the shape that was used when the filter was built.
+ *
* @return The shape the filter was built with.
*/
Shape getShape();
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 cdad5286e..0a1dbed67 100644
---
a/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java
+++
b/src/main/java/org/apache/commons/collections4/bloomfilter/CountingBloomFilter.java
@@ -234,6 +234,7 @@ public interface CountingBloomFilter extends
BloomFilter<CountingBloomFilter>, C
* to a CellExtractor and add that.</li>
* <li>Implementations should throw {@code IllegalArgumentException} and
no other exception on bad input.</li>
* </ul>
+ *
* @param indexExtractor the IndexExtractor
* @return {@code true} if the removal was successful and the state is
valid
* @see #isValid()
@@ -348,6 +349,7 @@ public interface CountingBloomFilter extends
BloomFilter<CountingBloomFilter>, C
/**
* The default implementation is a no-op since the counting bloom filter
returns an unique IndexExtractor by default.
+ *
* @return this counting Bloom filter.
*/
@Override
diff --git
a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
index a494ee9aa..646093f29 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
@@ -32,6 +32,7 @@ public final class IndexFilter {
/**
* An IndexTracker implementation that uses an array of integers to track
whether or not a
* number has been seen. Suitable for Shapes that have few hash functions.
+ *
* @since 4.5.0
*/
static class ArrayTracker implements IntPredicate {
@@ -40,6 +41,7 @@ public final class IndexFilter {
/**
* Constructs the tracker based on the shape.
+ *
* @param shape the shape to build the tracker for.
*/
ArrayTracker(final Shape shape) {
@@ -70,6 +72,7 @@ public final class IndexFilter {
/**
* Constructs a bit map based tracker for the specified shape.
+ *
* @param shape The shape that is being generated.
*/
BitMapTracker(final Shape shape) {
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 607bf0517..7aa9b1c59 100644
---
a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
+++
b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
@@ -361,6 +361,7 @@ public class LayerManager<T extends BloomFilter<T>>
implements BloomFilterExtrac
/**
* Gets the Bloom filter from the first layer.
* No extension check is performed during this call.
+ *
* @return The Bloom filter from the first layer.
* @see #getTarget()
*/
diff --git
a/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
b/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
index 34ce3d3d7..e764eb556 100644
---
a/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
@@ -67,6 +67,7 @@ public abstract class AbstractCollectionDecorator<E>
/**
* Constructor only used in deserialization, do not use otherwise.
+ *
* @since 3.1
*/
protected AbstractCollectionDecorator() {
diff --git
a/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
b/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
index 1b21ab333..d89db8d66 100644
---
a/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
+++
b/src/main/java/org/apache/commons/collections4/collection/CompositeCollection.java
@@ -37,6 +37,7 @@ import org.apache.commons.collections4.list.UnmodifiableList;
* Add and remove operations require the use of a pluggable strategy. If no
* strategy is provided then add and remove are unsupported.
* </p>
+ *
* @param <E> the type of the elements in the collection
* @since 3.0
*/
@@ -228,6 +229,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
* <p>
* This implementation calls {@code clear()} on each collection.
* </p>
+ *
* @throws UnsupportedOperationException if clear is unsupported
*/
@Override
@@ -242,6 +244,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
* <p>
* This implementation calls {@code contains()} on each collection.
* </p>
+ *
* @param obj the object to search for
* @return true if obj is contained in any of the contained collections
*/
@@ -261,6 +264,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
* This implementation calls {@code contains()} for each element in the
* specified collection.
* </p>
+ *
* @param coll the collection to check for
* @return true if all elements contained
*/
@@ -288,6 +292,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
/**
* Gets the collection mutator to be used for this CompositeCollection.
+ *
* @return CollectionMutator<E>
*/
protected CollectionMutator<E> getMutator() {
@@ -299,6 +304,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
* <p>
* This implementation calls {@code isEmpty()} on each collection.
* </p>
+ *
* @return true if all of the contained collections are empty
*/
@Override
@@ -316,6 +322,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
* <p>
* This implementation uses an {@code IteratorChain}.
* </p>
+ *
* @return an {@code IteratorChain} instance which supports
* {@code remove()}. Iteration occurs over contained collections in
* the order they were added, but this behavior should not be relied upon.
@@ -356,6 +363,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
* <p>
* This implementation calls {@code removeAll} on each collection.
* </p>
+ *
* @param coll the collection to remove
* @return true if the collection was modified
* @throws UnsupportedOperationException if removeAll is unsupported
@@ -386,6 +394,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
* <p>
* This implementation calls {@code removeIf} on each collection.
* </p>
+ *
* @param filter a predicate which returns true for elements to be removed
* @return true if the collection was modified
* @throws UnsupportedOperationException if removeIf is unsupported
@@ -409,6 +418,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
* <p>
* This implementation calls {@code retainAll()} on each collection.
* </p>
+ *
* @param coll the collection to remove
* @return true if the collection was modified
* @throws UnsupportedOperationException if retainAll is unsupported
@@ -438,6 +448,7 @@ public class CompositeCollection<E> implements
Collection<E>, Serializable {
* <p>
* This implementation calls {@code size()} on each collection.
* </p>
+ *
* @return total number of elements in all contained containers
*/
@Override
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/BoundedIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/BoundedIterator.java
index 73d3b2f31..300910b44 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/BoundedIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/BoundedIterator.java
@@ -82,6 +82,7 @@ public class BoundedIterator<E> implements Iterator<E> {
/**
* Checks whether the iterator is still within its bounded range.
+ *
* @return {@code true} if the iterator is within its bounds, {@code
false} otherwise
*/
private boolean checkBounds() {
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
index 52265fec2..1aac23f18 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java
@@ -30,6 +30,7 @@ public class EmptyMapIterator<K, V> extends
AbstractEmptyMapIterator<K, V> imple
/**
* Singleton instance of the iterator.
+ *
* @since 3.1
*/
@SuppressWarnings("rawtypes")
@@ -37,6 +38,7 @@ public class EmptyMapIterator<K, V> extends
AbstractEmptyMapIterator<K, V> imple
/**
* Gets a typed instance of the iterator.
+ *
* @param <K> the key type
* @param <V> the value type
* @return {@link MapIterator}<K, V>
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
index 0ee07de62..b3e0fb4de 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java
@@ -30,6 +30,7 @@ public class EmptyOrderedMapIterator<K, V> extends
AbstractEmptyMapIterator<K, V
/**
* Singleton instance of the iterator.
+ *
* @since 3.1
*/
@SuppressWarnings("rawtypes")
@@ -37,6 +38,7 @@ public class EmptyOrderedMapIterator<K, V> extends
AbstractEmptyMapIterator<K, V
/**
* Gets a typed instance of the iterator.
+ *
* @param <K> the key type
* @param <V> the value type
* @return {@link OrderedMapIterator}<K, V>
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java
index 7a2e88b72..67fb422c4 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java
@@ -109,6 +109,7 @@ public class FilterListIterator<E> implements
ListIterator<E> {
/**
* Not supported.
+ *
* @param o the element to insert
*/
@Override
@@ -194,6 +195,7 @@ public class FilterListIterator<E> implements
ListIterator<E> {
/**
* Not supported.
+ *
* @param ignored the element with which to replace the last element
returned by
* {@code next} or {@code previous}
*/
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/PermutationIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/PermutationIterator.java
index 542cdae0d..6aace6657 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/PermutationIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/PermutationIterator.java
@@ -71,6 +71,7 @@ public class PermutationIterator<E> implements
Iterator<List<E>> {
/**
* Standard constructor for this class.
+ *
* @param collection the collection to generate permutations for
* @throws NullPointerException if coll is null
*/
@@ -91,6 +92,7 @@ public class PermutationIterator<E> implements
Iterator<List<E>> {
/**
* Indicates if there are more permutation available.
+ *
* @return true if there are more permutations, otherwise false
*/
@Override
@@ -100,6 +102,7 @@ public class PermutationIterator<E> implements
Iterator<List<E>> {
/**
* Returns the next permutation of the input collection.
+ *
* @return a list of the permutator's elements representing a permutation
* @throws NoSuchElementException if there are no more permutations
*/
diff --git
a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
index 6496e41a7..53529a98b 100644
---
a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
+++
b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
@@ -140,6 +140,7 @@ public class SingletonListIterator<E> implements
ResettableListIterator<E> {
/**
* Remove the object from this iterator.
+ *
* @throws IllegalStateException if the {@code next} or {@code previous}
* method has not yet been called, or the {@code remove} method
* has already been called after the last call to {@code next}
diff --git
a/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
b/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
index 4515372d2..dcc621eb3 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/MultiKey.java
@@ -233,6 +233,7 @@ public class MultiKey<K> implements Serializable {
/**
* Calculate the hash code of the instance using the provided keys.
+ *
* @param keys the keys to calculate the hash code for
*/
private void calculateHashCode(final Object[] keys) {
@@ -316,6 +317,7 @@ public class MultiKey<K> implements Serializable {
* Recalculate the hash code after deserialization. The hash code of some
* keys might have change (hash codes based on the system hash code are
* only stable for the same process).
+ *
* @return the instance with recalculated hash code
*/
protected Object readResolve() {
diff --git
a/src/main/java/org/apache/commons/collections4/list/AbstractListDecorator.java
b/src/main/java/org/apache/commons/collections4/list/AbstractListDecorator.java
index 25ecf6266..ee85167de 100644
---
a/src/main/java/org/apache/commons/collections4/list/AbstractListDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/list/AbstractListDecorator.java
@@ -38,6 +38,7 @@ public abstract class AbstractListDecorator<E> extends
AbstractCollectionDecorat
/**
* Constructor only used in deserialization, do not use otherwise.
+ *
* @since 3.1
*/
protected AbstractListDecorator() {
diff --git
a/src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java
b/src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java
index 5047b1ac7..ffcae5ee2 100644
---
a/src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/map/AbstractMapDecorator.java
@@ -47,6 +47,7 @@ public abstract class AbstractMapDecorator<K, V> extends
AbstractIterableMap<K,
/**
* Constructor only used in deserialization, do not use otherwise.
+ *
* @since 3.1
*/
protected AbstractMapDecorator() {
diff --git
a/src/main/java/org/apache/commons/collections4/map/AbstractOrderedMapDecorator.java
b/src/main/java/org/apache/commons/collections4/map/AbstractOrderedMapDecorator.java
index 3e7fad759..71894f8d9 100644
---
a/src/main/java/org/apache/commons/collections4/map/AbstractOrderedMapDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/map/AbstractOrderedMapDecorator.java
@@ -42,6 +42,7 @@ public abstract class AbstractOrderedMapDecorator<K, V>
extends AbstractMapDecor
/**
* Constructor only used in deserialization, do not use otherwise.
+ *
* @since 3.1
*/
protected AbstractOrderedMapDecorator() {
diff --git
a/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
b/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
index 3b0852155..bf1040351 100644
---
a/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
+++
b/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
@@ -309,6 +309,7 @@ public abstract class AbstractReferenceMap<K, V> extends
AbstractHashedMap<K, V>
/**
* Purges the specified reference
+ *
* @param ref the reference to purge
* @return true or false
*/
@@ -517,6 +518,7 @@ public abstract class AbstractReferenceMap<K, V> extends
AbstractHashedMap<K, V>
/**
* Resolve enum from int.
+ *
* @param value the int value
* @return ReferenceType
* @throws IllegalArgumentException if the specified value is invalid.
diff --git
a/src/main/java/org/apache/commons/collections4/map/AbstractSortedMapDecorator.java
b/src/main/java/org/apache/commons/collections4/map/AbstractSortedMapDecorator.java
index 78a49ef6a..75a6d7dca 100644
---
a/src/main/java/org/apache/commons/collections4/map/AbstractSortedMapDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/map/AbstractSortedMapDecorator.java
@@ -59,6 +59,7 @@ public abstract class AbstractSortedMapDecorator<K, V>
extends AbstractMapDecora
/**
* Create a new AbstractSortedMapDecorator.SortedMapIterator.
+ *
* @param entrySet the entrySet to iterate
*/
protected SortedMapIterator(final Set<Map.Entry<K, V>> entrySet) {
@@ -94,6 +95,7 @@ public abstract class AbstractSortedMapDecorator<K, V>
extends AbstractMapDecora
/**
* Constructor only used in deserialization, do not use otherwise.
+ *
* @since 3.1
*/
protected AbstractSortedMapDecorator() {
diff --git
a/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
b/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
index 3f9d57ee3..636e14d9e 100644
---
a/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
+++
b/src/main/java/org/apache/commons/collections4/map/EntrySetToMapIteratorAdapter.java
@@ -43,6 +43,7 @@ public class EntrySetToMapIteratorAdapter<K, V> implements
MapIterator<K, V>, Re
/**
* Create a new EntrySetToMapIteratorAdapter.
+ *
* @param entrySet the entrySet to adapt
*/
public EntrySetToMapIteratorAdapter(final Set<Map.Entry<K, V>> entrySet) {
@@ -52,6 +53,7 @@ public class EntrySetToMapIteratorAdapter<K, V> implements
MapIterator<K, V>, Re
/**
* Gets the currently active entry.
+ *
* @return Map.Entry<K, V>
*/
protected synchronized Map.Entry<K, V> current() {
diff --git
a/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
b/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
index f14371f9b..de34ee31b 100644
---
a/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
+++
b/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
@@ -242,6 +242,7 @@ public abstract class AbstractListValuedMap<K, V> extends
AbstractMultiValuedMap
/**
* Creates a new value collection using the provided factory.
+ *
* @return a new list
*/
@Override
diff --git
a/src/main/java/org/apache/commons/collections4/multimap/AbstractSetValuedMap.java
b/src/main/java/org/apache/commons/collections4/multimap/AbstractSetValuedMap.java
index 5f3b940cf..ff98ea2b7 100644
---
a/src/main/java/org/apache/commons/collections4/multimap/AbstractSetValuedMap.java
+++
b/src/main/java/org/apache/commons/collections4/multimap/AbstractSetValuedMap.java
@@ -87,6 +87,7 @@ public abstract class AbstractSetValuedMap<K, V> extends
AbstractMultiValuedMap<
/**
* Creates a new value collection using the provided factory.
+ *
* @return a new set
*/
@Override
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 19e7f620c..317e7d2c5 100644
---
a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
+++
b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
@@ -64,6 +64,7 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
/**
* Constructs a new instance.
+ *
* @param decorated the iterator to decorate
* @param parent the parent multiset
*/
@@ -174,6 +175,7 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
/**
* Constructs a new instance.
+ *
* @param parentEntry the entry to decorate
*/
protected MultiSetEntry(final Map.Entry<E, MutableInteger>
parentEntry) {
@@ -200,6 +202,7 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
/**
* Constructs a new instance.
+ *
* @param value the initial value
*/
MutableInteger(final int value) {
@@ -238,6 +241,7 @@ public abstract class AbstractMapMultiSet<E> extends
AbstractMultiSet<E> {
/**
* Constructs a new instance.
+ *
* @param iterator the iterator to decorate
* @param parent the parent multiset
*/
diff --git
a/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java
b/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java
index 426ad6438..9fdc2188f 100644
---
a/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java
+++
b/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java
@@ -45,6 +45,7 @@ public class SynchronizedMultiSet<E> extends
SynchronizedCollection<E> implement
/**
* Constructs a new instance.
+ *
* @param set the set to decorate
* @param lock the lock to use, shared with the multiset
*/
diff --git
a/src/main/java/org/apache/commons/collections4/set/AbstractSetDecorator.java
b/src/main/java/org/apache/commons/collections4/set/AbstractSetDecorator.java
index 7df2cd040..9b0d010d8 100644
---
a/src/main/java/org/apache/commons/collections4/set/AbstractSetDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/set/AbstractSetDecorator.java
@@ -37,6 +37,7 @@ public abstract class AbstractSetDecorator<E> extends
AbstractCollectionDecorato
/**
* Constructor only used in deserialization, do not use otherwise.
+ *
* @since 3.1
*/
protected AbstractSetDecorator() {
diff --git
a/src/main/java/org/apache/commons/collections4/set/AbstractSortedSetDecorator.java
b/src/main/java/org/apache/commons/collections4/set/AbstractSortedSetDecorator.java
index 4ac4831f1..14d8d8277 100644
---
a/src/main/java/org/apache/commons/collections4/set/AbstractSortedSetDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/set/AbstractSortedSetDecorator.java
@@ -38,6 +38,7 @@ public abstract class AbstractSortedSetDecorator<E>
/**
* Constructor only used in deserialization, do not use otherwise.
+ *
* @since 3.1
*/
protected AbstractSortedSetDecorator() {
diff --git
a/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
b/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
index 6560153fc..7c51e5eee 100644
--- a/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
@@ -289,6 +289,7 @@ public class CompositeSet<E> implements Set<E>,
Serializable {
/**
* {@inheritDoc}
+ *
* @see java.util.Set#equals
*/
@Override
@@ -302,6 +303,7 @@ public class CompositeSet<E> implements Set<E>,
Serializable {
/**
* Gets the set mutator to be used for this CompositeSet.
+ *
* @return the set mutator
*/
protected SetMutator<E> getMutator() {
@@ -319,6 +321,7 @@ public class CompositeSet<E> implements Set<E>,
Serializable {
/**
* {@inheritDoc}
+ *
* @see java.util.Set#hashCode
*/
@Override
diff --git
a/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
b/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
index 6b394e1fc..60bfe5df5 100644
---
a/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
+++
b/src/main/java/org/apache/commons/collections4/splitmap/AbstractIterableGetMapDecorator.java
@@ -46,6 +46,7 @@ public class AbstractIterableGetMapDecorator<K, V> implements
IterableGet<K, V>
/**
* Create a new AbstractSplitMapDecorator.
+ *
* @param map the map to decorate, must not be null
* @throws NullPointerException if map is null
*/
@@ -107,6 +108,7 @@ public class AbstractIterableGetMapDecorator<K, V>
implements IterableGet<K, V>
/**
* Gets a MapIterator over this Get.
+ *
* @return MapIterator<K, V>
*/
@Override
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 b934f7c83..5e7d69a2d 100644
---
a/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java
+++
b/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java
@@ -184,6 +184,7 @@ public abstract class AbstractBitwiseTrie<K, V> extends
AbstractMap<K, V>
/**
* 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/analyzer/StringKeyAnalyzer.java
b/src/main/java/org/apache/commons/collections4/trie/analyzer/StringKeyAnalyzer.java
index d3d76a258..6b0aaa6df 100644
---
a/src/main/java/org/apache/commons/collections4/trie/analyzer/StringKeyAnalyzer.java
+++
b/src/main/java/org/apache/commons/collections4/trie/analyzer/StringKeyAnalyzer.java
@@ -23,6 +23,7 @@ import org.apache.commons.collections4.trie.KeyAnalyzer;
* <p>
* This class is stateless.
* </p>
+ *
* @since 4.0
*/
public class StringKeyAnalyzer extends KeyAnalyzer<String> {
