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 86e97e6d336ff00b8bea697041da0a4d7172e0db Author: Gary Gregory <[email protected]> AuthorDate: Sun Jan 4 11:22:38 2026 -0500 Javadoc Add an empty line before a Javadoc comment --- src/main/java/org/apache/commons/collections4/Equator.java | 1 + .../java/org/apache/commons/collections4/IterableGet.java | 1 + .../java/org/apache/commons/collections4/IteratorUtils.java | 1 + .../apache/commons/collections4/bag/SynchronizedBag.java | 1 + .../commons/collections4/bidimap/AbstractDualBidiMap.java | 2 ++ .../commons/collections4/bidimap/DualTreeBidiMap.java | 1 + .../apache/commons/collections4/bidimap/TreeBidiMap.java | 11 +++++++++++ .../commons/collections4/bloomfilter/CellExtractor.java | 2 ++ .../collections4/collection/SynchronizedCollection.java | 1 + .../commons/collections4/comparators/ComparatorChain.java | 2 ++ .../apache/commons/collections4/functors/AndPredicate.java | 1 + .../apache/commons/collections4/functors/ForClosure.java | 1 + .../org/apache/commons/collections4/functors/IfClosure.java | 2 ++ .../apache/commons/collections4/functors/IfTransformer.java | 2 ++ .../commons/collections4/functors/InstantiateFactory.java | 3 +++ .../collections4/functors/InstantiateTransformer.java | 1 + .../commons/collections4/functors/InvokerTransformer.java | 2 ++ .../apache/commons/collections4/functors/OrPredicate.java | 1 + .../commons/collections4/functors/PrototypeFactory.java | 1 + .../apache/commons/collections4/functors/SwitchClosure.java | 2 ++ .../commons/collections4/functors/SwitchTransformer.java | 2 ++ .../apache/commons/collections4/functors/WhileClosure.java | 2 ++ .../commons/collections4/iterators/ArrayIterator.java | 3 +++ .../commons/collections4/iterators/EnumerationIterator.java | 2 ++ .../commons/collections4/iterators/ListIteratorWrapper.java | 3 +++ .../commons/collections4/iterators/LoopingIterator.java | 1 + .../commons/collections4/iterators/LoopingListIterator.java | 1 + .../commons/collections4/iterators/NodeListIterator.java | 1 + .../commons/collections4/iterators/ObjectArrayIterator.java | 3 +++ .../commons/collections4/iterators/ObjectGraphIterator.java | 5 +++++ .../commons/collections4/iterators/ReverseListIterator.java | 2 ++ .../commons/collections4/iterators/SingletonIterator.java | 3 +++ .../commons/collections4/iterators/TransformIterator.java | 1 + .../commons/collections4/keyvalue/AbstractKeyValue.java | 1 + .../commons/collections4/list/AbstractLinkedList.java | 2 ++ .../commons/collections4/list/AbstractLinkedListJava21.java | 6 ++++++ .../commons/collections4/list/CursorableLinkedList.java | 3 +++ .../java/org/apache/commons/collections4/list/TreeList.java | 13 +++++++++++++ .../apache/commons/collections4/map/AbstractHashedMap.java | 1 + .../apache/commons/collections4/map/AbstractLinkedMap.java | 2 ++ .../commons/collections4/map/AbstractReferenceMap.java | 4 ++++ .../org/apache/commons/collections4/map/CompositeMap.java | 1 + .../collections4/map/ConcurrentReferenceHashMap.java | 4 ++++ .../java/org/apache/commons/collections4/map/Flat3Map.java | 1 + .../java/org/apache/commons/collections4/map/LRUMap.java | 2 ++ .../org/apache/commons/collections4/map/MultiValueMap.java | 1 + .../org/apache/commons/collections4/map/SingletonMap.java | 1 + .../org/apache/commons/collections4/map/TransformedMap.java | 1 + .../commons/collections4/multiset/AbstractMapMultiSet.java | 2 ++ .../commons/collections4/multiset/SynchronizedMultiSet.java | 1 + .../commons/collections4/sequence/SequencesComparator.java | 1 + .../commons/collections4/splitmap/TransformedSplitMap.java | 1 + .../commons/collections4/trie/AbstractPatriciaTrie.java | 2 ++ .../org/apache/commons/collections4/FactoryUtilsTest.java | 1 + .../collections4/bloomfilter/AbstractCellExtractorTest.java | 1 + .../bloomfilter/AbstractIndexExtractorTest.java | 1 + .../collections4/bloomfilter/LayeredBloomFilterTest.java | 1 + .../commons/collections4/bloomfilter/TestingHashers.java | 1 + .../collections4/collection/CompositeCollectionTest.java | 2 ++ .../collections4/functors/AbstractMockPredicateTest.java | 1 + .../collections4/iterators/ExtendedIteratorTest.java | 1 + .../apache/commons/collections4/list/SetUniqueListTest.java | 1 + .../apache/commons/collections4/map/AbstractMapTest.java | 1 + .../apache/commons/collections4/map/EmptyMapMutator.java | 1 + 64 files changed, 130 insertions(+) diff --git a/src/main/java/org/apache/commons/collections4/Equator.java b/src/main/java/org/apache/commons/collections4/Equator.java index c43ab1d74..9d99322ff 100644 --- a/src/main/java/org/apache/commons/collections4/Equator.java +++ b/src/main/java/org/apache/commons/collections4/Equator.java @@ -27,6 +27,7 @@ package org.apache.commons.collections4; * @since 4.0 */ public interface Equator<T> { + /** * Evaluates the two arguments for their equality. * diff --git a/src/main/java/org/apache/commons/collections4/IterableGet.java b/src/main/java/org/apache/commons/collections4/IterableGet.java index 85aca7634..0c3b89372 100644 --- a/src/main/java/org/apache/commons/collections4/IterableGet.java +++ b/src/main/java/org/apache/commons/collections4/IterableGet.java @@ -25,6 +25,7 @@ package org.apache.commons.collections4; * @see Put */ public interface IterableGet<K, V> extends Get<K, V> { + /** * Obtains a {@code MapIterator} over the map. * <p> diff --git a/src/main/java/org/apache/commons/collections4/IteratorUtils.java b/src/main/java/org/apache/commons/collections4/IteratorUtils.java index ed65c964f..6a7e53d0d 100644 --- a/src/main/java/org/apache/commons/collections4/IteratorUtils.java +++ b/src/main/java/org/apache/commons/collections4/IteratorUtils.java @@ -112,6 +112,7 @@ public class IteratorUtils { */ @SuppressWarnings("rawtypes") public static final OrderedMapIterator EMPTY_ORDERED_MAP_ITERATOR = EmptyOrderedMapIterator.INSTANCE; + /** * Default delimiter used to delimit elements while converting an Iterator * to its String representation. 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 5990e1a83..ea95fb28f 100644 --- a/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java @@ -41,6 +41,7 @@ public class SynchronizedBag<E> extends SynchronizedCollection<E> implements Bag * Synchronized Set for the Bag class. */ final class SynchronizedBagSet extends SynchronizedCollection<E> implements Set<E> { + /** Serialization version */ private static final long serialVersionUID = 2990565892366827855L; 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 f22501b84..333179cc4 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java @@ -747,6 +747,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { } // Map views + /** * Gets a keySet view of the map. * Changes made on the view are reflected in the map. @@ -763,6 +764,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { } // BidiMap + /** * Obtains a {@code MapIterator} over the map. * The iterator implements {@link BidiMapIterator}. 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 e897be87b..e1fcbe5c9 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java @@ -173,6 +173,7 @@ public class DualTreeBidiMap<K, V> extends AbstractDualBidiMap<K, V> * @param <V> the type of the values. */ protected static class ViewMap<K, V> extends AbstractSortedMapDecorator<K, V> { + /** * Constructs a new instance. * 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 2524c11a9..f04dcf93a 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java @@ -120,12 +120,16 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> /** Whether to return KEY or VALUE order. */ private final DataElement orderType; + /** The last node returned by the iterator. */ Node<K, V> lastReturnedNode; + /** The next node to be returned by the iterator. */ private Node<K, V> nextNode; + /** The previous node in the sequence returned by the iterator. */ private Node<K, V> previousNode; + /** The modification count. */ private int expectedModifications; @@ -216,6 +220,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> return description; } } + /** * A view of this map. */ @@ -256,6 +261,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> return false; } } + /** * The inverse map implementation. */ @@ -263,8 +269,10 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> /** Store the keySet once created. */ private Set<V> inverseKeySet; + /** Store the valuesSet once created. */ private Set<K> inverseValuesSet; + /** Store the entrySet once created. */ private Set<Map.Entry<V, K>> inverseEntrySet; @@ -409,6 +417,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> return inverseValuesSet; } } + /** * A view of this map. */ @@ -449,6 +458,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> return false; } } + /** * An iterator over the inverse map entries. */ @@ -475,6 +485,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> return createEntry(navigatePrevious()); } } + /** * An iterator over the map. */ diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/CellExtractor.java b/src/main/java/org/apache/commons/collections4/bloomfilter/CellExtractor.java index 0334b7479..2536d94b1 100644 --- a/src/main/java/org/apache/commons/collections4/bloomfilter/CellExtractor.java +++ b/src/main/java/org/apache/commons/collections4/bloomfilter/CellExtractor.java @@ -51,6 +51,7 @@ public interface CellExtractor extends IndexExtractor { */ @FunctionalInterface interface CellPredicate { + /** * Performs an operation on the given {@code <index, count>} pair. * @@ -84,6 +85,7 @@ public interface CellExtractor extends IndexExtractor { */ static CellExtractor from(final IndexExtractor indexExtractor) { return new CellExtractor() { + /** * Class to track cell values in the TreeMap. */ diff --git a/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java b/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java index 820727fed..dbe9d50d9 100644 --- a/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java +++ b/src/main/java/org/apache/commons/collections4/collection/SynchronizedCollection.java @@ -58,6 +58,7 @@ public class SynchronizedCollection<E> implements Collection<E>, Serializable { public static <T> SynchronizedCollection<T> synchronizedCollection(final Collection<T> coll) { return new SynchronizedCollection<>(coll); } + /** The collection to decorate */ private final Collection<E> collection; diff --git a/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java b/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java index 6e42f2935..253ddce5b 100644 --- a/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java +++ b/src/main/java/org/apache/commons/collections4/comparators/ComparatorChain.java @@ -58,8 +58,10 @@ public class ComparatorChain<E> implements Comparator<E>, Serializable { /** The list of comparators in the chain. */ private final List<Comparator<E>> comparatorChain; + /** Order - false (clear) = ascend; true (set) = descend. */ private final BitSet orderingBits; + /** Whether the chain has been "locked". */ private boolean isLocked; diff --git a/src/main/java/org/apache/commons/collections4/functors/AndPredicate.java b/src/main/java/org/apache/commons/collections4/functors/AndPredicate.java index 40d8896ef..5c2137451 100644 --- a/src/main/java/org/apache/commons/collections4/functors/AndPredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/AndPredicate.java @@ -46,6 +46,7 @@ public final class AndPredicate<T> extends AbstractPredicate<T> implements Predi return new AndPredicate<>(Objects.requireNonNull(predicate1, "predicate1"), Objects.requireNonNull(predicate2, "predicate2")); } + /** The array of predicates to call */ private final Predicate<? super T> iPredicate1; diff --git a/src/main/java/org/apache/commons/collections4/functors/ForClosure.java b/src/main/java/org/apache/commons/collections4/functors/ForClosure.java index 67eb9d0aa..8fc4f5801 100644 --- a/src/main/java/org/apache/commons/collections4/functors/ForClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/ForClosure.java @@ -53,6 +53,7 @@ public class ForClosure<T> implements Closure<T> { } return new ForClosure<>(count, closure); } + /** The number of times to loop */ private final int iCount; diff --git a/src/main/java/org/apache/commons/collections4/functors/IfClosure.java b/src/main/java/org/apache/commons/collections4/functors/IfClosure.java index 964f16d90..54072b79b 100644 --- a/src/main/java/org/apache/commons/collections4/functors/IfClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/IfClosure.java @@ -50,6 +50,7 @@ public class IfClosure<T> implements Closure<T>, Serializable { public static <E> Closure<E> ifClosure(final Predicate<? super E> predicate, final Closure<? super E> trueClosure) { return IfClosure.<E>ifClosure(predicate, trueClosure, NOPClosure.<E>nopClosure()); } + /** * Factory method that performs validation. * @@ -67,6 +68,7 @@ public class IfClosure<T> implements Closure<T>, Serializable { Objects.requireNonNull(trueClosure, "trueClosure"), Objects.requireNonNull(falseClosure, "falseClosure")); } + /** The test */ private final Predicate<? super T> iPredicate; diff --git a/src/main/java/org/apache/commons/collections4/functors/IfTransformer.java b/src/main/java/org/apache/commons/collections4/functors/IfTransformer.java index 97e0c2171..7743c5337 100644 --- a/src/main/java/org/apache/commons/collections4/functors/IfTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/IfTransformer.java @@ -53,6 +53,7 @@ public class IfTransformer<T, R> implements Transformer<T, R>, Serializable { Objects.requireNonNull(trueTransformer, "trueTransformer"), Objects.requireNonNull(falseTransformer, "falseTransformer")); } + /** * Factory method that performs validation. * <p> @@ -71,6 +72,7 @@ public class IfTransformer<T, R> implements Transformer<T, R>, Serializable { return new IfTransformer<>(Objects.requireNonNull(predicate, "predicate"), Objects.requireNonNull(trueTransformer, "trueTransformer"), NOPTransformer.<T>nopTransformer()); } + /** The test */ private final Predicate<? super T> iPredicate; diff --git a/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java b/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java index cb263f6f1..e8f2d2275 100644 --- a/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java +++ b/src/main/java/org/apache/commons/collections4/functors/InstantiateFactory.java @@ -63,10 +63,13 @@ public class InstantiateFactory<T> implements Factory<T> { } return new InstantiateFactory<>(classToInstantiate, paramTypes, args); } + /** The class to create */ private final Class<T> iClassToInstantiate; + /** The constructor parameter types */ private final Class<?>[] iParamTypes; + /** The constructor arguments */ private final Object[] iArgs; diff --git a/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java b/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java index e1c3f0986..18361e5c1 100644 --- a/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/InstantiateTransformer.java @@ -49,6 +49,7 @@ public class InstantiateTransformer<T> implements Transformer<Class<? extends T> public static <T> Transformer<Class<? extends T>, T> instantiateTransformer() { return NO_ARG_INSTANCE; } + /** * Transformer method that performs validation. * diff --git a/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java b/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java index f24cea644..263a306d0 100644 --- a/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/InvokerTransformer.java @@ -51,6 +51,7 @@ public class InvokerTransformer<T, R> implements Transformer<T, R> { public static <I, O> Transformer<I, O> invokerTransformer(final String methodName) { return new InvokerTransformer<>(Objects.requireNonNull(methodName, "methodName")); } + /** * Gets an instance of this transformer calling a specific method with specific values. * @@ -76,6 +77,7 @@ public class InvokerTransformer<T, R> implements Transformer<T, R> { } return new InvokerTransformer<>(methodName, paramTypes, args); } + /** The method name to call */ private final String iMethodName; diff --git a/src/main/java/org/apache/commons/collections4/functors/OrPredicate.java b/src/main/java/org/apache/commons/collections4/functors/OrPredicate.java index 4576cc85b..92572a583 100644 --- a/src/main/java/org/apache/commons/collections4/functors/OrPredicate.java +++ b/src/main/java/org/apache/commons/collections4/functors/OrPredicate.java @@ -46,6 +46,7 @@ public final class OrPredicate<T> extends AbstractPredicate<T> implements Predic return new OrPredicate<>(Objects.requireNonNull(predicate1, "predicate1"), Objects.requireNonNull(predicate2, "predicate2")); } + /** The array of predicates to call */ private final Predicate<? super T> iPredicate1; diff --git a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java index 5333dbec4..5c1fada97 100644 --- a/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java +++ b/src/main/java/org/apache/commons/collections4/functors/PrototypeFactory.java @@ -51,6 +51,7 @@ public class PrototypeFactory { /** The object to clone each time */ private final T iPrototype; + /** The method used to clone */ private transient Method iCloneMethod; diff --git a/src/main/java/org/apache/commons/collections4/functors/SwitchClosure.java b/src/main/java/org/apache/commons/collections4/functors/SwitchClosure.java index a63c67c22..2d20c1ad1 100644 --- a/src/main/java/org/apache/commons/collections4/functors/SwitchClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/SwitchClosure.java @@ -72,6 +72,7 @@ public class SwitchClosure<T> implements Closure<T>, Serializable { } return new SwitchClosure<>(false, preds, closures, defaultClosure); } + /** * Factory method that performs validation and copies the parameter arrays. * @@ -98,6 +99,7 @@ public class SwitchClosure<T> implements Closure<T>, Serializable { } return new SwitchClosure<>(predicates, closures, defaultClosure); } + /** The tests to consider */ private final Predicate<? super T>[] iPredicates; diff --git a/src/main/java/org/apache/commons/collections4/functors/SwitchTransformer.java b/src/main/java/org/apache/commons/collections4/functors/SwitchTransformer.java index a73a7fe4f..213d1d5b9 100644 --- a/src/main/java/org/apache/commons/collections4/functors/SwitchTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/SwitchTransformer.java @@ -81,6 +81,7 @@ public class SwitchTransformer<T, R> implements Transformer<T, R>, Serializable } return new SwitchTransformer<>(false, preds, transformers, defaultTransformer); } + /** * Factory method that performs validation and copies the parameter arrays. * @@ -109,6 +110,7 @@ public class SwitchTransformer<T, R> implements Transformer<T, R>, Serializable } return new SwitchTransformer<>(predicates, transformers, defaultTransformer); } + /** The tests to consider */ private final Predicate<? super T>[] iPredicates; diff --git a/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java b/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java index 84b235f3b..cd9f984f5 100644 --- a/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/WhileClosure.java @@ -51,8 +51,10 @@ public class WhileClosure<T> implements Closure<T> { return new WhileClosure<>(Objects.requireNonNull(predicate, "predicate"), Objects.requireNonNull(closure, "closure"), doLoop); } + /** The test condition */ private final Predicate<? super T> iPredicate; + /** The closure to call */ private final Closure<? super T> iClosure; diff --git a/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java index f972cdf27..b19a8ec53 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java @@ -41,10 +41,13 @@ public class ArrayIterator<E> implements ResettableIterator<E> { /** The array to iterate over */ final Object array; + /** The start index to loop from */ final int startIndex; + /** The end index to loop to */ final int endIndex; + /** The current iterator index */ int index; 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 4030569e7..9a83e7ebf 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EnumerationIterator.java @@ -31,8 +31,10 @@ public class EnumerationIterator<E> implements Iterator<E> { /** The collection to remove elements from */ private final Collection<? super E> collection; + /** The enumeration being converted */ private Enumeration<? extends E> enumeration; + /** The last object retrieved */ private E last; diff --git a/src/main/java/org/apache/commons/collections4/iterators/ListIteratorWrapper.java b/src/main/java/org/apache/commons/collections4/iterators/ListIteratorWrapper.java index 3d227940a..dbba4b722 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ListIteratorWrapper.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ListIteratorWrapper.java @@ -60,13 +60,16 @@ public class ListIteratorWrapper<E> implements ResettableListIterator<E> { /** The underlying iterator being decorated. */ private final Iterator<? extends E> iterator; + /** The list being used to cache the iterator. */ private final List<E> list = new ArrayList<>(); /** The current index of this iterator. */ private int currentIndex; + /** The current index of the wrapped iterator. */ private int wrappedIteratorIndex; + /** Recall whether the wrapped iterator's "cursor" is in such a state as to allow remove() to be called */ private boolean removeState; diff --git a/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java b/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java index 31fb99dc6..0bcdea5ee 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java @@ -42,6 +42,7 @@ public class LoopingIterator<E> implements ResettableIterator<E> { /** The collection to base the iterator on */ private final Collection<? extends E> collection; + /** The current iterator */ private Iterator<? extends E> iterator; diff --git a/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java index 0c47deecc..1f76ddf04 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java @@ -44,6 +44,7 @@ public class LoopingListIterator<E> implements ResettableListIterator<E> { /** The list to base the iterator on */ private final List<E> list; + /** The current list iterator */ private ListIterator<E> iterator; diff --git a/src/main/java/org/apache/commons/collections4/iterators/NodeListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/NodeListIterator.java index 82f4682d9..916eeab92 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/NodeListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/NodeListIterator.java @@ -37,6 +37,7 @@ public class NodeListIterator implements Iterator<Node> { /** The original NodeList instance */ private final NodeList nodeList; + /** The current iterator index */ private int index; diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java index c45909d94..2c0d82631 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java @@ -38,10 +38,13 @@ public class ObjectArrayIterator<E> implements ResettableIterator<E> { /** The array */ final E[] array; + /** The start index to loop from */ final int startIndex; + /** The end index to loop to */ final int endIndex; + /** The current iterator index */ int index; diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectGraphIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectGraphIterator.java index 2cc1f1a19..daae6e426 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ObjectGraphIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectGraphIterator.java @@ -84,17 +84,22 @@ public class ObjectGraphIterator<E> implements Iterator<E> { /** The stack of iterators */ private final Deque<Iterator<? extends E>> stack = new ArrayDeque<>(8); + /** The root object in the tree */ private E root; + /** The transformer to use */ private final Transformer<? super E, ? extends E> transformer; /** Whether there is another element in the iteration */ private boolean hasNext; + /** The current iterator */ private Iterator<? extends E> currentIterator; + /** The current value */ private E currentValue; + /** The last used iterator, needed for remove() */ private Iterator<? extends E> lastUsedIterator; diff --git a/src/main/java/org/apache/commons/collections4/iterators/ReverseListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ReverseListIterator.java index 287bdf5b7..921c66f09 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/ReverseListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/ReverseListIterator.java @@ -42,8 +42,10 @@ public class ReverseListIterator<E> implements ResettableListIterator<E> { /** The list being wrapped. */ private final List<E> list; + /** The list iterator being wrapped. */ private ListIterator<E> iterator; + /** Flag to indicate if updating is possible at the moment. */ private boolean validForUpdate = true; diff --git a/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java b/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java index 87dd8d19d..49b4fb687 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/SingletonIterator.java @@ -32,10 +32,13 @@ public class SingletonIterator<E> /** Whether remove is allowed */ private final boolean removeAllowed; + /** Is the cursor before the first element */ private boolean beforeFirst = true; + /** Has the element been removed */ private boolean removed; + /** The object */ private E object; diff --git a/src/main/java/org/apache/commons/collections4/iterators/TransformIterator.java b/src/main/java/org/apache/commons/collections4/iterators/TransformIterator.java index 36dc0b9f1..f7b4113fd 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/TransformIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/TransformIterator.java @@ -31,6 +31,7 @@ public class TransformIterator<I, O> implements Iterator<O> { /** The iterator being used */ private Iterator<? extends I> iterator; + /** The transformer being used */ private Transformer<? super I, ? extends O> transformer; diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractKeyValue.java b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractKeyValue.java index 24bdd5567..4a602681a 100644 --- a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractKeyValue.java +++ b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractKeyValue.java @@ -30,6 +30,7 @@ public abstract class AbstractKeyValue<K, V> implements KeyValue<K, V> { /** The key */ private K key; + /** The value */ private V value; diff --git a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java index ab18d7b03..fe9e30ea2 100644 --- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java +++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java @@ -438,8 +438,10 @@ public abstract class AbstractLinkedList<E> implements List<E> { /** A pointer to the node before this node */ protected Node<E> previous; + /** A pointer to the node after this node */ protected Node<E> next; + /** The object contained within this node */ protected E value; diff --git a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListJava21.java b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListJava21.java index e2a7c52e2..7a79d4dc3 100644 --- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListJava21.java +++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListJava21.java @@ -229,12 +229,16 @@ public abstract class AbstractLinkedListJava21<E> implements List<E> { * @param <E> the type of elements in this list. */ protected static class LinkedSubList<E> extends AbstractList<E> { + /** The main list */ AbstractLinkedListJava21<E> parent; + /** Offset from the main list */ int offset; + /** Sublist size */ int size; + /** Sublist modCount */ int expectedModCount; @@ -437,8 +441,10 @@ public abstract class AbstractLinkedListJava21<E> implements List<E> { /** A pointer to the node before this node */ protected Node<E> previous; + /** A pointer to the node after this node */ protected Node<E> next; + /** The object contained within this node */ protected E value; diff --git a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java index df080a21e..c8e231b4c 100644 --- a/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java +++ b/src/main/java/org/apache/commons/collections4/list/CursorableLinkedList.java @@ -70,10 +70,13 @@ public class CursorableLinkedList<E> extends AbstractLinkedList<E> implements Se * @param <E> the type of elements in this cursor. */ public static class Cursor<E> extends AbstractLinkedList.LinkedListIterator<E> { + /** Is the cursor valid (not closed) */ boolean valid = true; + /** Is the next index valid */ boolean nextIndexValid = true; + /** Flag to indicate if the current element was removed by another object. */ boolean currentRemovedByAnother; 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 778e93672..a0e1c7145 100644 --- a/src/main/java/org/apache/commons/collections4/list/TreeList.java +++ b/src/main/java/org/apache/commons/collections4/list/TreeList.java @@ -83,18 +83,25 @@ public class TreeList<E> extends AbstractList<E> { * </p> */ static class AVLNode<E> { + /** The left child node or the predecessor if {@link #leftIsPrevious}.*/ private AVLNode<E> left; + /** Flag indicating that left reference is not a subtree but the predecessor. */ private boolean leftIsPrevious; + /** The right child node or the successor if {@link #rightIsNext}. */ private AVLNode<E> right; + /** Flag indicating that right reference is not a subtree but the successor. */ private boolean rightIsNext; + /** How many levels of left/right are below this one. */ private int height; + /** The relative position, root holds absolute position. */ private int relativePosition; + /** The stored element. */ private E value; @@ -757,25 +764,31 @@ public class TreeList<E> extends AbstractList<E> { * A list iterator over the linked list. */ static class TreeListIterator<E> implements ListIterator<E>, OrderedIterator<E> { + /** The parent list */ private final TreeList<E> parent; + /** * Cache of the next node that will be returned by {@link #next()}. */ private AVLNode<E> next; + /** * The index of the next node to be returned. */ private int nextIndex; + /** * Cache of the last node that was returned by {@link #next()} * or {@link #previous()}. */ private AVLNode<E> current; + /** * The index of the last node that was returned. */ private int currentIndex; + /** * The modification count that the list is expected to have. If the list * doesn't have this count, then a diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java b/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java index 683072cc8..aee103d8b 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java @@ -235,6 +235,7 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab return new StringBuilder().append(getKey()).append('=').append(getValue()).toString(); } } + /** * Base Iterator. * diff --git a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java index 4473831a5..4f17657fb 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java @@ -140,8 +140,10 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im * @param <V> the value type. */ protected static class LinkEntry<K, V> extends HashEntry<K, V> { + /** The entry before this one in the order */ protected LinkEntry<K, V> before; + /** The entry after this one in the order */ protected LinkEntry<K, V> after; 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 bf1040351..42f84c294 100644 --- a/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java +++ b/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java @@ -94,6 +94,7 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V> * Base iterator class. */ static class ReferenceBaseIterator<K, V> { + /** The parent map */ final AbstractReferenceMap<K, V> parent; @@ -197,6 +198,7 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V> * @since 3.1 */ protected static class ReferenceEntry<K, V> extends HashEntry<K, V> { + /** The parent map */ private final AbstractReferenceMap<K, V> parent; @@ -588,6 +590,7 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V> * A soft reference holder. */ static class SoftRef<T> extends SoftReference<T> { + /** The hashCode of the key (even if the reference points to a value) */ private final int hash; @@ -621,6 +624,7 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V> * A weak reference holder. */ static class WeakRef<T> extends WeakReference<T> { + /** The hashCode of the key (even if the reference points to a value) */ private final int hash; 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 9c26db3f3..8161d6cb1 100644 --- a/src/main/java/org/apache/commons/collections4/map/CompositeMap.java +++ b/src/main/java/org/apache/commons/collections4/map/CompositeMap.java @@ -56,6 +56,7 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser * @param <V> the type of the values in the map */ public interface MapMutator<K, V> extends Serializable { + /** * Called when the CompositeMap.put() method is invoked. * 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 78a5bc9f5..79e8e40f9 100644 --- a/src/main/java/org/apache/commons/collections4/map/ConcurrentReferenceHashMap.java +++ b/src/main/java/org/apache/commons/collections4/map/ConcurrentReferenceHashMap.java @@ -625,6 +625,7 @@ public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implemen * Behavior-changing configuration options for the map */ public enum Option { + /** * Indicates that referential-equality (== instead of .equals()) should be used when locating keys. This offers similar behavior to * {@link IdentityHashMap} @@ -636,14 +637,17 @@ public class ConcurrentReferenceHashMap<K, V> extends AbstractMap<K, V> implemen * An option specifying which Java reference type should be used to refer to a key and/or value. */ public enum ReferenceType { + /** * Indicates a normal Java strong reference should be used */ STRONG, + /** * Indicates a {@link WeakReference} should be used */ WEAK, + /** * Indicates a {@link SoftReference} should be used */ diff --git a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java b/src/main/java/org/apache/commons/collections4/map/Flat3Map.java index ec679989e..1d68fe033 100644 --- a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java +++ b/src/main/java/org/apache/commons/collections4/map/Flat3Map.java @@ -161,6 +161,7 @@ public class Flat3Map<K, V> implements IterableMap<K, V>, Serializable, Cloneabl return parent.size(); } } + /** * EntrySetIterator and MapEntry */ diff --git a/src/main/java/org/apache/commons/collections4/map/LRUMap.java b/src/main/java/org/apache/commons/collections4/map/LRUMap.java index 73ae5c539..feecbe44c 100644 --- a/src/main/java/org/apache/commons/collections4/map/LRUMap.java +++ b/src/main/java/org/apache/commons/collections4/map/LRUMap.java @@ -68,11 +68,13 @@ public class LRUMap<K, V> /** Serialization version */ private static final long serialVersionUID = -612114643488955218L; + /** Default maximum size */ protected static final int DEFAULT_MAX_SIZE = 100; /** Maximum size */ private transient int maxSize; + /** Scan behavior */ private final boolean scanUntilRemovable; diff --git a/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java b/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java index f75d62389..7d3cd3c8d 100644 --- a/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java +++ b/src/main/java/org/apache/commons/collections4/map/MultiValueMap.java @@ -135,6 +135,7 @@ public class MultiValueMap<K, V> extends AbstractMapDecorator<K, Object> impleme return totalSize(); } } + /** * Inner class that provides the values iterator. */ diff --git a/src/main/java/org/apache/commons/collections4/map/SingletonMap.java b/src/main/java/org/apache/commons/collections4/map/SingletonMap.java index c8a29a8ae..a9f3fc8fb 100644 --- a/src/main/java/org/apache/commons/collections4/map/SingletonMap.java +++ b/src/main/java/org/apache/commons/collections4/map/SingletonMap.java @@ -183,6 +183,7 @@ public class SingletonMap<K, V> return 1; } } + /** Serialization version */ private static final long serialVersionUID = -8931271118676803261L; diff --git a/src/main/java/org/apache/commons/collections4/map/TransformedMap.java b/src/main/java/org/apache/commons/collections4/map/TransformedMap.java index d358f2953..6dcd47d87 100644 --- a/src/main/java/org/apache/commons/collections4/map/TransformedMap.java +++ b/src/main/java/org/apache/commons/collections4/map/TransformedMap.java @@ -84,6 +84,7 @@ public class TransformedMap<K, V> } return decorated; } + /** * Factory method to create a transforming map. * <p> 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 317e7d2c5..0e24a6e16 100644 --- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java +++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java @@ -96,6 +96,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> { canRemove = false; } } + /** * Inner class iterator for the MultiSet. */ @@ -197,6 +198,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> { * Mutable integer class for storing the data. */ protected static class MutableInteger { + /** The value of this mutable. */ protected int value; 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 9fdc2188f..ccffd0946 100644 --- a/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java +++ b/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java @@ -40,6 +40,7 @@ public class SynchronizedMultiSet<E> extends SynchronizedCollection<E> implement * @param <T> the type held in this Set. */ static class SynchronizedSet<T> extends SynchronizedCollection<T> implements Set<T> { + /** Serialization version */ private static final long serialVersionUID = 20150629L; diff --git a/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java b/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java index fd50612a2..a16ae01ad 100644 --- a/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java +++ b/src/main/java/org/apache/commons/collections4/sequence/SequencesComparator.java @@ -124,6 +124,7 @@ public class SequencesComparator<T> { /** The equator used for testing object equality. */ private final Equator<? super T> equator; + /** Temporary variables. */ private final int[] vDown; diff --git a/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java b/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java index daea74af8..b1127a37e 100644 --- a/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java +++ b/src/main/java/org/apache/commons/collections4/splitmap/TransformedSplitMap.java @@ -92,6 +92,7 @@ public class TransformedSplitMap<J, K, U, V> extends AbstractIterableGetMapDecor final Transformer<? super U, ? extends V> valueTransformer) { return new TransformedSplitMap<>(map, keyTransformer, valueTransformer); } + /** The transformer to use for the key */ private final Transformer<? super J, ? extends K> keyTransformer; 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 906d3c620..a8a367c2c 100644 --- a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java +++ b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java @@ -342,6 +342,7 @@ public abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K, return AbstractPatriciaTrie.this.size(); } } + /** * This is a key set view of the {@link org.apache.commons.collections4.Trie} as returned by {@link Map#keySet()}. */ @@ -384,6 +385,7 @@ public abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K, return AbstractPatriciaTrie.this.size(); } } + /** * A prefix {@link RangeEntrySet} view of the {@link org.apache.commons.collections4.Trie}. */ diff --git a/src/test/java/org/apache/commons/collections4/FactoryUtilsTest.java b/src/test/java/org/apache/commons/collections4/FactoryUtilsTest.java index c35b5b785..90f020bff 100644 --- a/src/test/java/org/apache/commons/collections4/FactoryUtilsTest.java +++ b/src/test/java/org/apache/commons/collections4/FactoryUtilsTest.java @@ -65,6 +65,7 @@ public class FactoryUtilsTest { } public static class Mock2 implements Serializable { + /** * Generated serial version ID. */ diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractCellExtractorTest.java b/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractCellExtractorTest.java index 2753bd4d6..0e1a95f19 100644 --- a/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractCellExtractorTest.java +++ b/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractCellExtractorTest.java @@ -34,6 +34,7 @@ public abstract class AbstractCellExtractorTest extends AbstractIndexExtractorTe * A testing CellConsumer that always returns true. */ private static final CellPredicate TRUE_CONSUMER = (i, j) -> true; + /** * A testing CellConsumer that always returns false. */ diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractIndexExtractorTest.java b/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractIndexExtractorTest.java index fefc54998..163743c84 100644 --- a/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractIndexExtractorTest.java +++ b/src/test/java/org/apache/commons/collections4/bloomfilter/AbstractIndexExtractorTest.java @@ -66,6 +66,7 @@ public abstract class AbstractIndexExtractorTest { private static final IntPredicate TRUE_PREDICATE = i -> true; private static final IntPredicate FALSE_PREDICATE = i -> false; + /** Flag to indicate the indices are ordered, for example from {@link IndexExtractor#processIndices(IntPredicate)}. */ protected static final int ORDERED = 0x1; diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilterTest.java b/src/test/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilterTest.java index de5ba276c..a4eb2a855 100644 --- a/src/test/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilterTest.java +++ b/src/test/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilterTest.java @@ -260,6 +260,7 @@ class LayeredBloomFilterTest extends AbstractBloomFilterTest<LayeredBloomFilter< f = underTest.get(0); assertEquals(3, f.sequence); // it is a new one. } + /** * Tests that the estimated union calculations are correct. */ diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/TestingHashers.java b/src/test/java/org/apache/commons/collections4/bloomfilter/TestingHashers.java index 161e2d0ff..90dce5789 100644 --- a/src/test/java/org/apache/commons/collections4/bloomfilter/TestingHashers.java +++ b/src/test/java/org/apache/commons/collections4/bloomfilter/TestingHashers.java @@ -22,6 +22,7 @@ import java.util.concurrent.ThreadLocalRandom; * A collection of methods and statics that represent standard hashers in testing. */ public class TestingHashers { + /** * Hasher that increments from 1. */ diff --git a/src/test/java/org/apache/commons/collections4/collection/CompositeCollectionTest.java b/src/test/java/org/apache/commons/collections4/collection/CompositeCollectionTest.java index 4a02113a4..b7116edd7 100644 --- a/src/test/java/org/apache/commons/collections4/collection/CompositeCollectionTest.java +++ b/src/test/java/org/apache/commons/collections4/collection/CompositeCollectionTest.java @@ -79,6 +79,7 @@ public class CompositeCollectionTest<E> extends AbstractCollectionTest<E> { public Collection<E> makeConfirmedFullCollection() { return new HashSet<>(Arrays.asList(getFullElements())); } + /** * Full collection consists of 4 collections, each with one element */ @@ -93,6 +94,7 @@ public class CompositeCollectionTest<E> extends AbstractCollectionTest<E> { } return compositeCollection; } + /** * Empty collection is empty composite */ diff --git a/src/test/java/org/apache/commons/collections4/functors/AbstractMockPredicateTest.java b/src/test/java/org/apache/commons/collections4/functors/AbstractMockPredicateTest.java index ad6e28065..b4bfeca14 100644 --- a/src/test/java/org/apache/commons/collections4/functors/AbstractMockPredicateTest.java +++ b/src/test/java/org/apache/commons/collections4/functors/AbstractMockPredicateTest.java @@ -32,6 +32,7 @@ import org.junit.jupiter.api.BeforeEach; * provides methods to create and verify mock predicates to which to delegate. */ public abstract class AbstractMockPredicateTest<T> { + /** * Mock predicates created by a single test case which need to be verified after the test completes. */ diff --git a/src/test/java/org/apache/commons/collections4/iterators/ExtendedIteratorTest.java b/src/test/java/org/apache/commons/collections4/iterators/ExtendedIteratorTest.java index 612bb6062..21ae01907 100644 --- a/src/test/java/org/apache/commons/collections4/iterators/ExtendedIteratorTest.java +++ b/src/test/java/org/apache/commons/collections4/iterators/ExtendedIteratorTest.java @@ -32,6 +32,7 @@ import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; class ExtendedIteratorTest { + /** * Collection of {@link Integer}s */ diff --git a/src/test/java/org/apache/commons/collections4/list/SetUniqueListTest.java b/src/test/java/org/apache/commons/collections4/list/SetUniqueListTest.java index 9cd1b4bd0..2a22a89c6 100644 --- a/src/test/java/org/apache/commons/collections4/list/SetUniqueListTest.java +++ b/src/test/java/org/apache/commons/collections4/list/SetUniqueListTest.java @@ -42,6 +42,7 @@ import org.junit.jupiter.api.Test; public class SetUniqueListTest<E> extends AbstractListTest<E> { final class SetUniqueList307 extends SetUniqueList<E> { + /** * Generated serial version ID. */ diff --git a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java index 1fa6a5220..1c7ee770a 100644 --- a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java +++ b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java @@ -164,6 +164,7 @@ public abstract class AbstractMapTest<M extends Map<K, V>, K, V> extends Abstrac } // Have to implement manually; entrySet doesn't support addAll + /** * {@inheritDoc} */ diff --git a/src/test/java/org/apache/commons/collections4/map/EmptyMapMutator.java b/src/test/java/org/apache/commons/collections4/map/EmptyMapMutator.java index a9871f667..75520d1e9 100644 --- a/src/test/java/org/apache/commons/collections4/map/EmptyMapMutator.java +++ b/src/test/java/org/apache/commons/collections4/map/EmptyMapMutator.java @@ -25,6 +25,7 @@ import java.util.Map; * class also has to be serialized. */ final class EmptyMapMutator<K, V> implements CompositeMap.MapMutator<K, V> { + /** Serialization version */ private static final long serialVersionUID = -2729718980002476794L;
