From 8e0bc678ad8aeb7b589098c73382e932629751f6 Mon Sep 17 00:00:00 2001 From: Gary Gregory Date: Thu, 14 Dec 2023 09:44:16 -0500 Subject: [PATCH] Javadoc --- .../collections4/bag/AbstractMapBag.java | 4 ++-- .../collections4/bag/SynchronizedBag.java | 2 +- .../bidimap/AbstractDualBidiMap.java | 18 +++++++++--------- .../collections4/bidimap/DualTreeBidiMap.java | 4 ++-- .../collections4/bidimap/TreeBidiMap.java | 10 +++++----- .../functors/CloneTransformer.java | 2 +- .../collections4/functors/NOPClosure.java | 2 +- .../collections4/functors/NOPTransformer.java | 2 +- .../iterators/AbstractEmptyIterator.java | 2 +- .../collections4/iterators/EmptyIterator.java | 2 +- .../iterators/EmptyListIterator.java | 2 +- .../iterators/EmptyMapIterator.java | 2 +- .../iterators/EmptyOrderedIterator.java | 2 +- .../iterators/EmptyOrderedMapIterator.java | 2 +- .../iterators/EntrySetMapIterator.java | 2 +- .../iterators/PeekingIterator.java | 2 +- .../iterators/PushbackIterator.java | 2 +- .../iterators/UnmodifiableIterator.java | 2 +- .../iterators/UnmodifiableListIterator.java | 2 +- .../iterators/UnmodifiableMapIterator.java | 2 +- .../UnmodifiableOrderedMapIterator.java | 2 +- .../commons/collections4/map/Flat3Map.java | 2 +- .../multiset/AbstractMapMultiSet.java | 10 +++++----- .../multiset/AbstractMultiSet.java | 2 +- .../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 87467df913..14f9324251 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 @@ static class BagIterator implements Iterator { private boolean canRemove; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent bag */ @@ -406,7 +406,7 @@ protected static class MutableInteger { 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 91f8822401..2b6e74b20f 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 @@ final class SynchronizedBagSet extends SynchronizedCollection implements Set< 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 2850312680..7670e122ca 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 @@ protected abstract static class View extends AbstractCollectionDecorato protected final AbstractDualBidiMap parent; /** - * Constructor. + * Constructs a new instance. * * @param coll the collection view being decorated * @param parent the parent BidiMap @@ -445,7 +445,7 @@ protected static class KeySet extends View implements Set { private static final long serialVersionUID = -7107935777385040694L; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent BidiMap */ @@ -492,7 +492,7 @@ protected static class KeySetIterator extends AbstractIteratorDecorator { protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent map */ @@ -532,7 +532,7 @@ protected static class Values extends View implements Set { private static final long serialVersionUID = 4023777119829639864L; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent BidiMap */ @@ -579,7 +579,7 @@ protected static class ValuesIterator extends AbstractIteratorDecorator { protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent map */ @@ -620,7 +620,7 @@ protected static class EntrySet extends View> implem private static final long serialVersionUID = 4040410962603292348L; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent BidiMap */ @@ -670,7 +670,7 @@ protected static class EntrySetIterator extends AbstractIteratorDecorator< protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent map */ @@ -712,7 +712,7 @@ protected static class MapEntry extends AbstractMapEntryDecorator { protected final AbstractDualBidiMap parent; /** - * Constructor. + * Constructs a new instance. * @param entry the entry to decorate * @param parent the parent map */ @@ -755,7 +755,7 @@ protected static class BidiMapIterator implements MapIterator, Reset protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param parent the parent map */ protected BidiMapIterator(final AbstractDualBidiMap 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 c5becd8d66..669522ce60 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 SortedBidiMap inverseBidiMap() { */ protected static class ViewMap extends AbstractSortedMapDecorator { /** - * Constructor. + * Constructs a new instance. * @param bidi the parent bidi map * @param sm the subMap sorted map */ @@ -310,7 +310,7 @@ protected static class BidiOrderedMapIterator implements OrderedMapIterato private Map.Entry last; /** - * Constructor. + * Constructs a new instance. * @param parent the parent map */ protected BidiOrderedMapIterator(final AbstractDualBidiMap 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 ec02fc8e9b..dd2c38ca40 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 @@ abstract class AbstractView extends AbstractSet { 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 @@ abstract class AbstractViewIterator { 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 final void remove() { final class ViewMapIterator extends AbstractViewIterator implements OrderedMapIterator { /** - * Constructor. + * Constructs a new instance. */ ViewMapIterator(final DataElement orderType) { super(orderType); @@ -1812,7 +1812,7 @@ public V previous() { final class ViewMapEntryIterator extends AbstractViewIterator implements OrderedIterator> { /** - * Constructor. + * Constructs a new instance. */ ViewMapEntryIterator() { super(KEY); @@ -1835,7 +1835,7 @@ public Map.Entry previous() { final class InverseViewMapEntryIterator extends AbstractViewIterator implements OrderedIterator> { /** - * 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 3009491c57..50c0b0465f 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 static Transformer cloneTransformer() { } /** - * 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 bfcb5b7499..5bfb050b40 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 static Closure nopClosure() { } /** - * 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 9d197c3b11..66cd2b2a07 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 static Transformer nopTransformer() { } /** - * 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 a7a6b89cef..6e9b7838b3 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 @@ abstract class AbstractEmptyIterator { /** - * 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 777f15ad3b..c33e0093a0 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 static Iterator emptyIterator() { } /** - * 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 4052097f51..f310b2ddb9 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 static ListIterator emptyListIterator() { } /** - * 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 d26fae801d..44b3354e85 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 static MapIterator emptyMapIterator() { } /** - * 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 d4dabe78d5..f4982f76dc 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 static OrderedIterator emptyOrderedIterator() { } /** - * 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 f47ea0da98..e70ce67584 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 static OrderedMapIterator emptyOrderedMapIterator() { } /** - * 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 8c00aaddf2..f46b4103a2 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 implements MapIterator, 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 7a37bd9d25..f4b9e1ecc7 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 static PeekingIterator peekingIterator(final Iterator } /** - * 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 b8b5efdc9c..275945d227 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 static PushbackIterator pushbackIterator(final Iterator Iterator unmodifiableIterator(final Iterator i } /** - * 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 807885e50d..3bd84792bc 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 static ListIterator umodifiableListIterator(final ListIterator MapIterator unmodifiableMapIterator( } /** - * 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 0da91e02bf..3794c39d82 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 static OrderedMapIterator unmodifiableOrderedMapIterator( } /** - * 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 4666a79392..33807a47f1 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 implements IterableMap, Serializable, Cloneabl private transient AbstractHashedMap 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 f83255aaec..0baaf6be74 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 @@ private static final class MapBasedMultiSetIterator implements Iterator { private boolean canRemove; /** - * Constructor. + * Constructs a new instance. * * @param parent the parent multiset */ @@ -273,7 +273,7 @@ protected static class MutableInteger { protected int value; /** - * Constructor. + * Constructs a new instance. * @param value the initial value */ MutableInteger(final int value) { @@ -324,7 +324,7 @@ protected static class UniqueSetIterator extends AbstractIteratorDecorator protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent multiset */ @@ -370,7 +370,7 @@ protected static class EntrySetIterator implements Iterator> { protected boolean canRemove; /** - * Constructor. + * Constructs a new instance. * @param iterator the iterator to decorate * @param parent the parent multiset */ @@ -411,7 +411,7 @@ protected static class MultiSetEntry extends AbstractEntry { protected final Map.Entry parentEntry; /** - * Constructor. + * Constructs a new instance. * @param parentEntry the entry to decorate */ protected MultiSetEntry(final Map.Entry 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 fe2b0793d0..e101af2a4a 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 @@ private static final class MultiSetIterator implements Iterator { 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 0093f6af16..63aa59ef78 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 @@ static class SynchronizedSet extends SynchronizedCollection implements Set 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 875e3009db..809fce3675 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 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