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 8e0bc678a Javadoc 8e0bc678a is described below commit 8e0bc678ad8aeb7b589098c73382e932629751f6 Author: Gary Gregory <garydgreg...@gmail.com> AuthorDate: Thu Dec 14 09:44:16 2023 -0500 Javadoc --- .../commons/collections4/bag/AbstractMapBag.java | 4 ++-- .../commons/collections4/bag/SynchronizedBag.java | 2 +- .../collections4/bidimap/AbstractDualBidiMap.java | 18 +++++++++--------- .../commons/collections4/bidimap/DualTreeBidiMap.java | 4 ++-- .../commons/collections4/bidimap/TreeBidiMap.java | 10 +++++----- .../collections4/functors/CloneTransformer.java | 2 +- .../commons/collections4/functors/NOPClosure.java | 2 +- .../commons/collections4/functors/NOPTransformer.java | 2 +- .../collections4/iterators/AbstractEmptyIterator.java | 2 +- .../commons/collections4/iterators/EmptyIterator.java | 2 +- .../collections4/iterators/EmptyListIterator.java | 2 +- .../collections4/iterators/EmptyMapIterator.java | 2 +- .../collections4/iterators/EmptyOrderedIterator.java | 2 +- .../iterators/EmptyOrderedMapIterator.java | 2 +- .../collections4/iterators/EntrySetMapIterator.java | 2 +- .../collections4/iterators/PeekingIterator.java | 2 +- .../collections4/iterators/PushbackIterator.java | 2 +- .../collections4/iterators/UnmodifiableIterator.java | 2 +- .../iterators/UnmodifiableListIterator.java | 2 +- .../iterators/UnmodifiableMapIterator.java | 2 +- .../iterators/UnmodifiableOrderedMapIterator.java | 2 +- .../org/apache/commons/collections4/map/Flat3Map.java | 2 +- .../collections4/multiset/AbstractMapMultiSet.java | 10 +++++----- .../collections4/multiset/AbstractMultiSet.java | 2 +- .../collections4/multiset/SynchronizedMultiSet.java | 2 +- .../set/AbstractSerializableSetDecorator.java | 2 +- 26 files changed, 44 insertions(+), 44 deletions(-) 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 87467df91..14f932425 100644 --- a/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/AbstractMapBag.java @@ -181,7 +181,7 @@ public abstract class AbstractMapBag<E> implements Bag<E> { private boolean canRemove; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent bag */ @@ -406,7 +406,7 @@ public abstract class AbstractMapBag<E> implements Bag<E> { protected int value; /** - * Constructor. + * Constructs a new instance. * @param value the initial value */ MutableInteger(final int value) { 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 91f882240..2b6e74b20 100644 --- a/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java +++ b/src/main/java/org/apache/commons/collections4/bag/SynchronizedBag.java @@ -137,7 +137,7 @@ public class SynchronizedBag<E> extends SynchronizedCollection<E> implements Bag private static final long serialVersionUID = 2990565892366827855L; /** - * Constructor. + * 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 285031268..7670e122c 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/AbstractDualBidiMap.java @@ -346,7 +346,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { protected final AbstractDualBidiMap<K, V> parent; /** - * Constructor. + * Constructs a new instance. * * @param coll the collection view being decorated * @param parent the parent BidiMap @@ -445,7 +445,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { private static final long serialVersionUID = -7107935777385040694L; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent BidiMap */ @@ -492,7 +492,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent map */ @@ -532,7 +532,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { private static final long serialVersionUID = 4023777119829639864L; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent BidiMap */ @@ -579,7 +579,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent map */ @@ -620,7 +620,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { private static final long serialVersionUID = 4040410962603292348L; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent BidiMap */ @@ -670,7 +670,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent map */ @@ -712,7 +712,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { protected final AbstractDualBidiMap<K, V> parent; /** - * Constructor. + * Constructs a new instance. * @param entry the entry to decorate * @param parent the parent map */ @@ -755,7 +755,7 @@ public abstract class AbstractDualBidiMap<K, V> implements BidiMap<K, V> { protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param parent the parent map */ protected BidiMapIterator(final AbstractDualBidiMap<K, V> parent) { 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 c5becd8d6..669522ce6 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java @@ -235,7 +235,7 @@ public class DualTreeBidiMap<K, V> extends AbstractDualBidiMap<K, V> */ protected static class ViewMap<K, V> extends AbstractSortedMapDecorator<K, V> { /** - * Constructor. + * Constructs a new instance. * @param bidi the parent bidi map * @param sm the subMap sorted map */ @@ -310,7 +310,7 @@ public class DualTreeBidiMap<K, V> extends AbstractDualBidiMap<K, V> private Map.Entry<K, V> last; /** - * Constructor. + * Constructs a new instance. * @param parent the parent map */ protected BidiOrderedMapIterator(final AbstractDualBidiMap<K, V> parent) { 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 ec02fc8e9..dd2c38ca4 100644 --- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java +++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java @@ -1477,7 +1477,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> final DataElement orderType; /** - * Constructor. + * Constructs a new instance. * @param orderType the KEY or VALUE int for the order */ AbstractView(final DataElement orderType) { @@ -1648,7 +1648,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> private int expectedModifications; /** - * Constructor. + * Constructs a new instance. * @param orderType the KEY or VALUE int for the order */ AbstractViewIterator(final DataElement orderType) { @@ -1720,7 +1720,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> final class ViewMapIterator extends AbstractViewIterator implements OrderedMapIterator<K, V> { /** - * Constructor. + * Constructs a new instance. */ ViewMapIterator(final DataElement orderType) { super(orderType); @@ -1812,7 +1812,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> final class ViewMapEntryIterator extends AbstractViewIterator implements OrderedIterator<Map.Entry<K, V>> { /** - * Constructor. + * Constructs a new instance. */ ViewMapEntryIterator() { super(KEY); @@ -1835,7 +1835,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>> final class InverseViewMapEntryIterator extends AbstractViewIterator implements OrderedIterator<Map.Entry<V, K>> { /** - * Constructor. + * Constructs a new instance. */ InverseViewMapEntryIterator() { super(VALUE); diff --git a/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java b/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java index 3009491c5..50c0b0465 100644 --- a/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/CloneTransformer.java @@ -50,7 +50,7 @@ public class CloneTransformer<T> implements Transformer<T, T> { } /** - * Constructor. + * Constructs a new instance. */ private CloneTransformer() { } diff --git a/src/main/java/org/apache/commons/collections4/functors/NOPClosure.java b/src/main/java/org/apache/commons/collections4/functors/NOPClosure.java index bfcb5b749..5bfb050b4 100644 --- a/src/main/java/org/apache/commons/collections4/functors/NOPClosure.java +++ b/src/main/java/org/apache/commons/collections4/functors/NOPClosure.java @@ -46,7 +46,7 @@ public final class NOPClosure<E> implements Closure<E>, Serializable { } /** - * Constructor. + * Constructs a new instance. */ private NOPClosure() { } diff --git a/src/main/java/org/apache/commons/collections4/functors/NOPTransformer.java b/src/main/java/org/apache/commons/collections4/functors/NOPTransformer.java index 9d197c3b1..66cd2b2a0 100644 --- a/src/main/java/org/apache/commons/collections4/functors/NOPTransformer.java +++ b/src/main/java/org/apache/commons/collections4/functors/NOPTransformer.java @@ -46,7 +46,7 @@ public class NOPTransformer<T> implements Transformer<T, T>, Serializable { } /** - * Constructor. + * Constructs a new instance. */ private NOPTransformer() { } diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java index a7a6b89ce..6e9b7838b 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java @@ -26,7 +26,7 @@ import java.util.NoSuchElementException; abstract class AbstractEmptyIterator<E> { /** - * Constructor. + * Constructs a new instance. */ protected AbstractEmptyIterator() { } diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java index 777f15ad3..c33e0093a 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyIterator.java @@ -65,7 +65,7 @@ public class EmptyIterator<E> extends AbstractEmptyIterator<E> implements Resett } /** - * Constructor. + * Constructs a new instance. */ protected EmptyIterator() { } diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java index 4052097f5..f310b2ddb 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyListIterator.java @@ -66,7 +66,7 @@ public class EmptyListIterator<E> extends AbstractEmptyIterator<E> implements } /** - * Constructor. + * Constructs a new instance. */ protected EmptyListIterator() { } 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 d26fae801..44b3354e8 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyMapIterator.java @@ -47,7 +47,7 @@ public class EmptyMapIterator<K, V> extends AbstractEmptyMapIterator<K, V> imple } /** - * Constructor. + * Constructs a new instance. */ protected EmptyMapIterator() { } diff --git a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java index d4dabe78d..f4982f76d 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedIterator.java @@ -45,7 +45,7 @@ public class EmptyOrderedIterator<E> extends AbstractEmptyIterator<E> } /** - * Constructor. + * Constructs a new instance. */ protected EmptyOrderedIterator() { } 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 f47ea0da9..e70ce6758 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EmptyOrderedMapIterator.java @@ -47,7 +47,7 @@ public class EmptyOrderedMapIterator<K, V> extends AbstractEmptyMapIterator<K, V } /** - * Constructor. + * Constructs a new instance. */ protected EmptyOrderedMapIterator() { } diff --git a/src/main/java/org/apache/commons/collections4/iterators/EntrySetMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/EntrySetMapIterator.java index 8c00aaddf..f46b4103a 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/EntrySetMapIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/EntrySetMapIterator.java @@ -46,7 +46,7 @@ public class EntrySetMapIterator<K, V> implements MapIterator<K, V>, ResettableI private boolean canRemove; /** - * Constructor. + * Constructs a new instance. * * @param map the map to iterate over */ diff --git a/src/main/java/org/apache/commons/collections4/iterators/PeekingIterator.java b/src/main/java/org/apache/commons/collections4/iterators/PeekingIterator.java index 7a37bd9d2..f4b9e1ecc 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/PeekingIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/PeekingIterator.java @@ -65,7 +65,7 @@ public class PeekingIterator<E> implements Iterator<E> { } /** - * Constructor. + * Constructs a new instance. * * @param iterator the iterator to decorate */ diff --git a/src/main/java/org/apache/commons/collections4/iterators/PushbackIterator.java b/src/main/java/org/apache/commons/collections4/iterators/PushbackIterator.java index b8b5efdc9..275945d22 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/PushbackIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/PushbackIterator.java @@ -62,7 +62,7 @@ public class PushbackIterator<E> implements Iterator<E> { } /** - * Constructor. + * Constructs a new instance. * * @param iterator the iterator to decorate */ diff --git a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableIterator.java b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableIterator.java index 5d86207d5..000ad1a28 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableIterator.java @@ -56,7 +56,7 @@ public final class UnmodifiableIterator<E> implements Iterator<E>, Unmodifiable } /** - * Constructor. + * Constructs a new instance. * * @param iterator the iterator to decorate */ diff --git a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java index 807885e50..3bd84792b 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java @@ -68,7 +68,7 @@ public final class UnmodifiableListIterator<E> implements ListIterator<E>, Unmod } /** - * Constructor. + * Constructs a new instance. * * @param iterator the iterator to decorate */ diff --git a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableMapIterator.java index 1827b9909..e6c9d9cba 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableMapIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableMapIterator.java @@ -57,7 +57,7 @@ public final class UnmodifiableMapIterator<K, V> implements MapIterator<K, V>, U } /** - * Constructor. + * Constructs a new instance. * * @param iterator the iterator to decorate */ diff --git a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableOrderedMapIterator.java b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableOrderedMapIterator.java index 0da91e02b..3794c39d8 100644 --- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableOrderedMapIterator.java +++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableOrderedMapIterator.java @@ -58,7 +58,7 @@ public final class UnmodifiableOrderedMapIterator<K, V> implements OrderedMapIte } /** - * Constructor. + * Constructs a new instance. * * @param iterator the iterator to decorate */ 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 4666a7939..33807a47f 100644 --- a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java +++ b/src/main/java/org/apache/commons/collections4/map/Flat3Map.java @@ -109,7 +109,7 @@ public class Flat3Map<K, V> implements IterableMap<K, V>, Serializable, Cloneabl private transient AbstractHashedMap<K, V> delegateMap; /** - * Constructor. + * Constructs a new instance. */ public Flat3Map() { } 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 f83255aae..0baaf6be7 100644 --- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java +++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java @@ -156,7 +156,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> { private boolean canRemove; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent multiset */ @@ -273,7 +273,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> { protected int value; /** - * Constructor. + * Constructs a new instance. * @param value the initial value */ MutableInteger(final int value) { @@ -324,7 +324,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> { protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent multiset */ @@ -370,7 +370,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> { protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent multiset */ @@ -411,7 +411,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> { protected final Map.Entry<E, MutableInteger> parentEntry; /** - * Constructor. + * Constructs a new instance. * @param parentEntry the entry to decorate */ protected MultiSetEntry(final Map.Entry<E, MutableInteger> parentEntry) { 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 fe2b0793d..e101af2a4 100644 --- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java +++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMultiSet.java @@ -130,7 +130,7 @@ public abstract class AbstractMultiSet<E> extends AbstractCollection<E> implemen private boolean canRemove; /** - * Constructor. + * Constructs a new instance. * * @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 0093f6af1..63aa59ef7 100644 --- a/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java +++ b/src/main/java/org/apache/commons/collections4/multiset/SynchronizedMultiSet.java @@ -149,7 +149,7 @@ public class SynchronizedMultiSet<E> extends SynchronizedCollection<E> implement private static final long serialVersionUID = 20150629L; /** - * Constructor. + * 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/AbstractSerializableSetDecorator.java b/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java index 875e3009d..809fce367 100644 --- a/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java +++ b/src/main/java/org/apache/commons/collections4/set/AbstractSerializableSetDecorator.java @@ -35,7 +35,7 @@ public abstract class AbstractSerializableSetDecorator<E> private static final long serialVersionUID = 1229469966212206107L; /** - * Constructor. + * Constructs a new instance. * * @param set the list to decorate, must not be null * @throws NullPointerException if set is null