You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2024/08/25 23:40:40 UTC
(commons-collections) branch master updated (6ae173285 -> edcc52421)
This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
from 6ae173285 Normalize spelling
new c788e536a Remove redundant keywords
new e542eca84 Better parameter names
new e75f6553a Better instance variable name
new 7023b20fb Better parameter names
new 552c114d4 Better parameter names
new e1068e8c7 Use final
new bd0dc26e3 Better instance variable name
new d243ff4fd Javadoc
new a06dee1b3 Use java.time
new 2ae865abc Javadoc
new a496f93aa Javadoc
new e6b8bbd08 Javadoc
new 2790d5c26 Fix Java `@since` tag
new d3271b9b3 Can't rename protected instance variable
new 7bab3d26f Javadoc
new b2cea54a2 Bump version properties
new c61faccf9 Javadoc
new edcc52421 Push down null checks
The 18 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
pom.xml | 4 +-
.../commons/collections4/FluentIterable.java | 2 +-
.../apache/commons/collections4/IterableUtils.java | 6 +-
.../apache/commons/collections4/SplitMapUtils.java | 4 +-
.../collections4/bidimap/DualTreeBidiMap.java | 11 +++
.../commons/collections4/bidimap/TreeBidiMap.java | 4 +-
.../bloomfilter/ArrayCountingBloomFilter.java | 2 +-
.../collections4/bloomfilter/BloomFilter.java | 2 +-
.../bloomfilter/BloomFilterExtractor.java | 2 +-
.../commons/collections4/bloomfilter/Hasher.java | 4 +-
.../collections4/bloomfilter/IndexFilter.java | 3 +-
.../collections4/bloomfilter/LayerManager.java | 27 +++-----
.../commons/collections4/bloomfilter/Shape.java | 2 +-
.../bloomfilter/SparseBloomFilter.java | 10 +--
.../bloomfilter/WrappedBloomFilter.java | 6 +-
.../collections4/bloomfilter/package-info.java | 2 +-
.../collection/AbstractCollectionDecorator.java | 6 +-
.../comparators/BooleanComparator.java | 2 +-
.../comparators/FixedOrderComparator.java | 19 +++++-
.../collections4/comparators/NullComparator.java | 10 +--
.../comparators/TransformingComparator.java | 6 +-
.../collections4/functors/ComparatorPredicate.java | 31 ++++++++-
.../iterators/AbstractMapIteratorDecorator.java | 4 +-
.../AbstractOrderedMapIteratorDecorator.java | 4 +-
.../collections4/iterators/ArrayIterator.java | 6 +-
.../collections4/iterators/ArrayListIterator.java | 20 +++---
.../collections4/iterators/CollatingIterator.java | 12 ++--
.../collections4/iterators/FilterListIterator.java | 4 +-
.../collections4/iterators/LoopingIterator.java | 2 +-
.../iterators/LoopingListIterator.java | 2 +-
.../iterators/ObjectArrayIterator.java | 18 ++---
.../iterators/ObjectArrayListIterator.java | 21 +++---
.../iterators/SingletonListIterator.java | 6 +-
.../iterators/UnmodifiableListIterator.java | 2 +-
.../keyvalue/AbstractMapEntryDecorator.java | 4 +-
.../collections4/list/AbstractLinkedList.java | 78 +++++++++++++++++++---
.../list/AbstractLinkedListForJava21.java | 2 +-
.../commons/collections4/list/TransformedList.java | 5 +-
.../collections4/map/AbstractHashedMap.java | 58 ++++++++++++++++
.../collections4/map/AbstractLinkedMap.java | 62 ++++++++++++++++-
.../collections4/map/AbstractReferenceMap.java | 40 +++++++----
.../commons/collections4/map/CompositeMap.java | 64 +++++++++---------
.../apache/commons/collections4/map/Flat3Map.java | 6 +-
.../commons/collections4/map/ListOrderedMap.java | 26 ++++----
.../commons/collections4/map/StaticBucketMap.java | 8 +--
.../collections4/map/UnmodifiableEntrySet.java | 2 +-
.../multimap/AbstractListValuedMap.java | 6 +-
.../multimap/AbstractMultiValuedMap.java | 32 +++++----
.../collections4/multiset/AbstractMapMultiSet.java | 12 +++-
.../commons/collections4/set/CompositeSet.java | 2 +-
.../collections4/trie/AbstractBitwiseTrie.java | 10 +++
.../collections4/trie/AbstractPatriciaTrie.java | 34 +++++++---
.../commons/collections4/trie/KeyAnalyzer.java | 5 +-
.../collections4/trie/UnmodifiableTrie.java | 3 +
.../collections4/bloomfilter/LayerManagerTest.java | 8 +--
.../bloomfilter/LayeredBloomFilterTest.java | 56 ++++++++--------
.../commons/collections4/map/AbstractMapTest.java | 12 ++--
.../commons/collections4/map/CompositeMapTest.java | 2 +-
.../multimap/AbstractMultiValuedMapTest.java | 12 ++--
.../commons/collections4/set/EmptySetMutator.java | 4 +-
60 files changed, 544 insertions(+), 275 deletions(-)
(commons-collections) 03/18: Better instance variable name
Posted by gg...@apache.org.
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 e75f6553adad17dbee0f1e665532d99e3b5f8882
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 16:22:25 2024 -0400
Better instance variable name
---
src/main/java/org/apache/commons/collections4/IterableUtils.java | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/IterableUtils.java b/src/main/java/org/apache/commons/collections4/IterableUtils.java
index 54ba8e6d0..4b3adadca 100644
--- a/src/main/java/org/apache/commons/collections4/IterableUtils.java
+++ b/src/main/java/org/apache/commons/collections4/IterableUtils.java
@@ -54,15 +54,15 @@ public class IterableUtils {
* Inner class to distinguish unmodifiable instances.
*/
private static final class UnmodifiableIterable<E> extends FluentIterable<E> {
- private final Iterable<E> unmodifiable;
+ private final Iterable<E> iterable;
UnmodifiableIterable(final Iterable<E> iterable) {
- this.unmodifiable = iterable;
+ this.iterable = iterable;
}
@Override
public Iterator<E> iterator() {
- return IteratorUtils.unmodifiableIterator(unmodifiable.iterator());
+ return IteratorUtils.unmodifiableIterator(iterable.iterator());
}
}
(commons-collections) 08/18: Javadoc
Posted by gg...@apache.org.
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 d243ff4fdef913842a108aa48abc0d48dbbcb018
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 16:39:51 2024 -0400
Javadoc
---
.../java/org/apache/commons/collections4/bloomfilter/package-info.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java b/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java
index e2b71f3b7..8f6600885 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/package-info.java
@@ -92,7 +92,7 @@
*
* <li>{@link org.apache.commons.collections4.bloomfilter.BloomFilter#characteristics()} which returns an integer of characteristics flags.</li>
*
- * <li>{@link org.apache.commons.collections4.bloomfilter.BloomFilter#clear()} which resets the Bloomfilter to its initial empty state.</li>
+ * <li>{@link org.apache.commons.collections4.bloomfilter.BloomFilter#clear()} which resets the Bloom filter to its initial empty state.</li>
*
* <li>{@link org.apache.commons.collections4.bloomfilter.BloomFilter#contains(IndexExtractor)} which returns true if the bits specified
* by the indices generated by IndexExtractor are enabled in the Bloom filter.</li>
(commons-collections) 16/18: Bump version properties
Posted by gg...@apache.org.
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 b2cea54a2c5e758fcb7eb616cb9df4b0da79cd9d
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 18:37:00 2024 -0400
Bump version properties
---
pom.xml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/pom.xml b/pom.xml
index e27434c64..0eb9e3840 100644
--- a/pom.xml
+++ b/pom.xml
@@ -114,8 +114,8 @@
<commons.componentid>collections</commons.componentid>
<commons.module.name>org.apache.commons.collections4</commons.module.name>
<!-- Current 4.x release series -->
- <commons.release.version>4.5.0-M2</commons.release.version>
- <commons.release.next>4.5.0-M3</commons.release.next>
+ <commons.release.version>4.5.0-M3</commons.release.version>
+ <commons.release.next>4.5.0-M4</commons.release.next>
<commons.release.desc>(Requires Java 8 or above)</commons.release.desc>
<!-- Previous 4.2 release on Java 7 -->
<commons.release.2.version>4.2</commons.release.2.version>
(commons-collections) 06/18: Use final
Posted by gg...@apache.org.
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 e1068e8c7a6cbade8a8c887932d2e2f70c04029c
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 16:32:14 2024 -0400
Use final
---
.../java/org/apache/commons/collections4/list/TransformedList.java | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/list/TransformedList.java b/src/main/java/org/apache/commons/collections4/list/TransformedList.java
index 8826695d0..eb701b264 100644
--- a/src/main/java/org/apache/commons/collections4/list/TransformedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/TransformedList.java
@@ -62,9 +62,8 @@ public class TransformedList<E> extends TransformedCollection<E> implements List
}
@Override
- public void set(E object) {
- object = transform(object);
- getListIterator().set(object);
+ public void set(final E object) {
+ getListIterator().set(transform(object));
}
}
(commons-collections) 05/18: Better parameter names
Posted by gg...@apache.org.
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 552c114d4b14225011df938051bb135e38dbd0d8
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 16:31:55 2024 -0400
Better parameter names
---
.../commons/collections4/iterators/CollatingIterator.java | 12 ++++++------
.../commons/collections4/iterators/FilterListIterator.java | 4 ++--
.../collections4/iterators/ObjectArrayListIterator.java | 1 -
.../collections4/iterators/SingletonListIterator.java | 6 +++---
.../collections4/iterators/UnmodifiableListIterator.java | 2 +-
5 files changed, 12 insertions(+), 13 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java b/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java
index 2e1c12901..87f65e53d 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/CollatingIterator.java
@@ -327,15 +327,15 @@ public class CollatingIterator<E> implements Iterator<E> {
*
* @return {@code false} iff there was no value to set
*/
- private boolean set(final int i) {
- final Iterator<? extends E> it = iterators.get(i);
+ private boolean set(final int index) {
+ final Iterator<? extends E> it = iterators.get(index);
if (it.hasNext()) {
- values.set(i, it.next());
- valueSet.set(i);
+ values.set(index, it.next());
+ valueSet.set(index);
return true;
}
- values.set(i, null);
- valueSet.clear(i);
+ values.set(index, null);
+ valueSet.clear(index);
return false;
}
diff --git a/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java
index ab6616ae0..f79c46f73 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/FilterListIterator.java
@@ -193,11 +193,11 @@ public class FilterListIterator<E> implements ListIterator<E> {
/**
* Not supported.
- * @param o the element with which to replace the last element returned by
+ * @param ignored the element with which to replace the last element returned by
* {@code next} or {@code previous}
*/
@Override
- public void set(final E o) {
+ public void set(final E ignored) {
throw new UnsupportedOperationException("FilterListIterator.set(Object) is not supported.");
}
diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
index faafa5703..0ce40da9b 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
@@ -189,7 +189,6 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
if (lastItemIndex == -1) {
throw new IllegalStateException("must call next() or previous() before a call to set()");
}
-
array[lastItemIndex] = obj;
}
diff --git a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
index dc9a0e139..871010909 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/SingletonListIterator.java
@@ -166,16 +166,16 @@ public class SingletonListIterator<E> implements ResettableListIterator<E> {
/**
* Sets sets the value of the singleton.
*
- * @param obj the object to set
+ * @param object the object to set
* @throws IllegalStateException if {@code next} has not been called
* or the object has been removed
*/
@Override
- public void set(final E obj) {
+ public void set(final E object) {
if (!nextCalled || removed) {
throw new IllegalStateException();
}
- this.object = obj;
+ this.object = object;
}
}
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 cf80ad6b6..ee4689d9a 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/UnmodifiableListIterator.java
@@ -117,7 +117,7 @@ public final class UnmodifiableListIterator<E> implements ListIterator<E>, Unmod
}
@Override
- public void set(final E obj) {
+ public void set(final E ignored) {
throw new UnsupportedOperationException("set() is not supported");
}
(commons-collections) 14/18: Can't rename protected instance variable
Posted by gg...@apache.org.
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 d3271b9b3fdf2c144e1cbc02f4f3b8b3ed1cf8eb
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 18:24:09 2024 -0400
Can't rename protected instance variable
- Javadoc: Better @link
---
.../commons/collections4/iterators/LoopingIterator.java | 2 +-
.../collections4/iterators/LoopingListIterator.java | 2 +-
.../commons/collections4/multiset/AbstractMapMultiSet.java | 14 +++++++-------
3 files changed, 9 insertions(+), 9 deletions(-)
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 7f0752005..ac62a1ce8 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/LoopingIterator.java
@@ -94,7 +94,7 @@ public class LoopingIterator<E> implements ResettableIterator<E> {
* Removes the previously retrieved item from the underlying collection.
* <p>
* This feature is only supported if the underlying collection's
- * {@link Collection#iterator iterator} method returns an implementation
+ * {@link Collection#iterator()} method returns an implementation
* that supports it.
* <p>
* This method can only be called after at least one {@link #next} method call.
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 279728e9b..0282fb2ac 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/LoopingListIterator.java
@@ -206,7 +206,7 @@ public class LoopingListIterator<E> implements ResettableListIterator<E> {
* Removes the previously retrieved item from the underlying list.
* <p>
* This feature is only supported if the underlying list's
- * {@link List#iterator iterator} method returns an implementation
+ * {@link List#iterator()} method returns an implementation
* that supports it.
* <p>
* This method can only be called after at least one {@link #next}
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 98f81dddf..dfdfaedbd 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
@@ -54,7 +54,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
/**
* The source Iterator.
*/
- protected final Iterator<Map.Entry<E, MutableInteger>> iterator;
+ protected final Iterator<Map.Entry<E, MutableInteger>> decorated;
/** The last returned entry */
protected Entry<E> last;
@@ -64,23 +64,23 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
/**
* Constructs a new instance.
- * @param iterator the iterator to decorate
+ * @param decorated the iterator to decorate
* @param parent the parent multiset
*/
- protected EntrySetIterator(final Iterator<Map.Entry<E, MutableInteger>> iterator,
+ protected EntrySetIterator(final Iterator<Map.Entry<E, MutableInteger>> decorated,
final AbstractMapMultiSet<E> parent) {
- this.iterator = iterator;
+ this.decorated = decorated;
this.parent = parent;
}
@Override
public boolean hasNext() {
- return iterator.hasNext();
+ return decorated.hasNext();
}
@Override
public Entry<E> next() {
- last = new MultiSetEntry<>(iterator.next());
+ last = new MultiSetEntry<>(decorated.next());
canRemove = true;
return last;
}
@@ -90,7 +90,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
if (!canRemove) {
throw new IllegalStateException("Iterator remove() can only be called once after next()");
}
- iterator.remove();
+ decorated.remove();
last = null;
canRemove = false;
}
(commons-collections) 13/18: Fix Java `@since` tag
Posted by gg...@apache.org.
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 2790d5c2679e2cc9087b5f3423bc89cb0f618c14
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 18:12:18 2024 -0400
Fix Java `@since` tag
---
.../apache/commons/collections4/list/AbstractLinkedListForJava21.java | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListForJava21.java b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListForJava21.java
index e1f854f3c..7a74f892b 100644
--- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListForJava21.java
+++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedListForJava21.java
@@ -44,7 +44,7 @@ import org.apache.commons.collections4.OrderedIterator;
* (see COLLECTIONS-842 for details).
*
* @param <E> the type of elements in this list
- * @since 3.0
+ * @since 4.5.0-M2
*/
public abstract class AbstractLinkedListForJava21<E> implements List<E> {
(commons-collections) 17/18: Javadoc
Posted by gg...@apache.org.
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 c61faccf9c81ff36f0d037b954ff620c97b0f8a5
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 18:55:28 2024 -0400
Javadoc
---
.../java/org/apache/commons/collections4/bloomfilter/BloomFilter.java | 2 +-
.../apache/commons/collections4/bloomfilter/BloomFilterExtractor.java | 2 +-
src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java | 4 ++--
.../java/org/apache/commons/collections4/bloomfilter/IndexFilter.java | 3 ++-
.../org/apache/commons/collections4/bloomfilter/LayerManager.java | 2 +-
src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java | 2 +-
6 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
index 3a6fe7199..0a6e1b38e 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilter.java
@@ -21,7 +21,7 @@ import java.util.Objects;
/**
* The interface that describes a Bloom filter.
* <p>
- * <em>See implementation notes for BitMapExtractor and IndexExtractor.</em>
+ * <em>See implementation notes for {@link BitMapExtractor} and {@link IndexExtractor}.</em>
* </p>
* @see BitMapExtractor
* @see IndexExtractor
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java
index 95dbc6800..e5f5a6aa7 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/BloomFilterExtractor.java
@@ -23,7 +23,7 @@ import java.util.function.BiPredicate;
import java.util.function.Predicate;
/**
- * Produces Bloom filters from a collection (e.g. LayeredBloomFilter).
+ * Produces Bloom filters from a collection (for example, {@link LayeredBloomFilter}).
*
* @since 4.5.0
*/
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java b/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java
index 4de30d0d6..ce4b9c227 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/Hasher.java
@@ -17,8 +17,8 @@
package org.apache.commons.collections4.bloomfilter;
/**
- * A Hasher creates IndexExtractor based on the hash implementation and the
- * provided Shape.
+ * A Hasher creates {@link IndexExtractor}s based on the hash implementation and the
+ * provided {@link Shape}.
*
* @since 4.5.0
*/
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
index a6c7c5b0d..300831b2c 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/IndexFilter.java
@@ -23,7 +23,8 @@ import java.util.function.IntPredicate;
*
* <p><em>If the index is negative the behavior is not defined.</em></p>
*
- * <p>This is conceptually a unique filter implemented as an {@code IntPredicate}.</p>
+ * <p>This is conceptually a unique filter implemented as an {@link IntPredicate}.</p>
+ *
* @since 4.5.0
*/
public final class IndexFilter {
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
index 2755a0ba0..5e18f99ba 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
@@ -289,7 +289,7 @@ public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor
private final Supplier<T> filterSupplier;
/**
- * Constructor.
+ * Constructs a new instance.
*
* @param filterSupplier the supplier of new Bloom filters to add the the list
* when necessary.
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java b/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java
index d490ba0e1..1411dee37 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/Shape.java
@@ -19,7 +19,7 @@ package org.apache.commons.collections4.bloomfilter;
/**
* The definition of a Bloom filter shape.
*
- * <p> This class contains the values for the filter configuration and is used to
+ * <p>This class contains the values for the filter configuration and is used to
* convert a Hasher into a BloomFilter as well as verify that two Bloom filters are
* compatible. (i.e. can be compared or merged)</p>
*
(commons-collections) 07/18: Better instance variable name
Posted by gg...@apache.org.
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 bd0dc26e35264c34ecbd50da2814679108d07d8e
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 16:36:46 2024 -0400
Better instance variable name
---
.../multimap/AbstractMultiValuedMap.java | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
index 90c60ecfd..27a24b020 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
@@ -72,12 +72,12 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
@Override
public boolean contains(final Object o) {
- return decoratedMap.entrySet().contains(o);
+ return map.entrySet().contains(o);
}
@Override
public Iterator<Map.Entry<K, Collection<V>>> iterator() {
- return new AsMapEntrySetIterator(decoratedMap.entrySet().iterator());
+ return new AsMapEntrySetIterator(map.entrySet().iterator());
}
@Override
@@ -113,10 +113,10 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
}
}
- final transient Map<K, Collection<V>> decoratedMap;
+ final transient Map<K, Collection<V>> map;
AsMap(final Map<K, Collection<V>> map) {
- this.decoratedMap = map;
+ this.map = map;
}
@Override
@@ -126,7 +126,7 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
@Override
public boolean containsKey(final Object key) {
- return decoratedMap.containsKey(key);
+ return map.containsKey(key);
}
@Override
@@ -136,12 +136,12 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
@Override
public boolean equals(final Object object) {
- return this == object || decoratedMap.equals(object);
+ return this == object || map.equals(object);
}
@Override
public Collection<V> get(final Object key) {
- final Collection<V> collection = decoratedMap.get(key);
+ final Collection<V> collection = map.get(key);
if (collection == null) {
return null;
}
@@ -152,7 +152,7 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
@Override
public int hashCode() {
- return decoratedMap.hashCode();
+ return map.hashCode();
}
@Override
@@ -162,7 +162,7 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
@Override
public Collection<V> remove(final Object key) {
- final Collection<V> collection = decoratedMap.remove(key);
+ final Collection<V> collection = map.remove(key);
if (collection == null) {
return null;
}
@@ -175,12 +175,12 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
@Override
public int size() {
- return decoratedMap.size();
+ return map.size();
}
@Override
public String toString() {
- return decoratedMap.toString();
+ return map.toString();
}
}
(commons-collections) 02/18: Better parameter names
Posted by gg...@apache.org.
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 e542eca84af464343bfbc016472658eba36fe7c3
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 16:22:02 2024 -0400
Better parameter names
---
.../apache/commons/collections4/bloomfilter/WrappedBloomFilter.java | 6 +++---
.../collections4/collection/AbstractCollectionDecorator.java | 6 +++---
src/main/java/org/apache/commons/collections4/map/Flat3Map.java | 6 +++---
.../commons/collections4/multimap/AbstractMultiValuedMapTest.java | 4 ++--
.../java/org/apache/commons/collections4/set/EmptySetMutator.java | 4 ++--
5 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/WrappedBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/WrappedBloomFilter.java
index 23afeee3a..a03ab0e85 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/WrappedBloomFilter.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/WrappedBloomFilter.java
@@ -30,10 +30,10 @@ public abstract class WrappedBloomFilter implements BloomFilter {
/**
* Wraps a Bloom filter. The wrapped filter is maintained as a reference
* not a copy. Changes in one will be reflected in the other.
- * @param bf The Bloom filter.
+ * @param wrapped The Bloom filter.
*/
- public WrappedBloomFilter(final BloomFilter bf) {
- this.wrapped = bf;
+ public WrappedBloomFilter(final BloomFilter wrapped) {
+ this.wrapped = wrapped;
}
@Override
diff --git a/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java b/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
index 0a5961308..c28e3ab51 100644
--- a/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/collection/AbstractCollectionDecorator.java
@@ -155,10 +155,10 @@ public abstract class AbstractCollectionDecorator<E>
* <p>
* <b>NOTE:</b> this method should only be used during deserialization
*
- * @param coll the decorated collection
+ * @param collection the decorated collection
*/
- protected void setCollection(final Collection<E> coll) {
- this.collection = coll;
+ protected void setCollection(final Collection<E> collection) {
+ this.collection = collection;
}
@Override
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 7a8a6b1a0..328fa5569 100644
--- a/src/main/java/org/apache/commons/collections4/map/Flat3Map.java
+++ b/src/main/java/org/apache/commons/collections4/map/Flat3Map.java
@@ -250,10 +250,10 @@ public class Flat3Map<K, V> implements IterableMap<K, V>, Serializable, Cloneabl
* As a consequence, all subsequent call to {@link #getKey()},
* {@link #setValue(Object)} and {@link #getValue()} will fail.
*
- * @param flag the new value of the removed flag
+ * @param removed the new value of the removed flag
*/
- void setRemoved(final boolean flag) {
- this.removed = flag;
+ void setRemoved(final boolean removed) {
+ this.removed = removed;
}
@Override
diff --git a/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java b/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java
index fd0e7b42d..ac80948e2 100644
--- a/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java
@@ -693,8 +693,8 @@ public abstract class AbstractMultiValuedMapTest<K, V> extends AbstractObjectTes
// assertEquals(expected, actual);
// }
- public void setConfirmed(final MultiValuedMap<K, V> map) {
- this.confirmed = map;
+ public void setConfirmed(final MultiValuedMap<K, V> confirmed) {
+ this.confirmed = confirmed;
}
@Test
diff --git a/src/test/java/org/apache/commons/collections4/set/EmptySetMutator.java b/src/test/java/org/apache/commons/collections4/set/EmptySetMutator.java
index 43c47a4bf..a1c4a071e 100644
--- a/src/test/java/org/apache/commons/collections4/set/EmptySetMutator.java
+++ b/src/test/java/org/apache/commons/collections4/set/EmptySetMutator.java
@@ -32,8 +32,8 @@ final class EmptySetMutator<E> implements CompositeSet.SetMutator<E> {
private final Set<E> contained;
- EmptySetMutator(final Set<E> set) {
- this.contained = set;
+ EmptySetMutator(final Set<E> contained) {
+ this.contained = contained;
}
@Override
(commons-collections) 11/18: Javadoc
Posted by gg...@apache.org.
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 a496f93aa0ce3336d73d619c2c56feefa1bd5bf2
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 17:54:46 2024 -0400
Javadoc
Better instance variable name
---
.../commons/collections4/multiset/AbstractMapMultiSet.java | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
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 0d9cd2805..a5e9ba259 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
@@ -51,7 +51,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
/** The parent map */
protected final AbstractMapMultiSet<E> parent;
- protected final Iterator<Map.Entry<E, MutableInteger>> decorated;
+ protected final Iterator<Map.Entry<E, MutableInteger>> iterator;
/** The last returned entry */
protected Entry<E> last;
@@ -66,18 +66,18 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
*/
protected EntrySetIterator(final Iterator<Map.Entry<E, MutableInteger>> iterator,
final AbstractMapMultiSet<E> parent) {
- this.decorated = iterator;
+ this.iterator = iterator;
this.parent = parent;
}
@Override
public boolean hasNext() {
- return decorated.hasNext();
+ return iterator.hasNext();
}
@Override
public Entry<E> next() {
- last = new MultiSetEntry<>(decorated.next());
+ last = new MultiSetEntry<>(iterator.next());
canRemove = true;
return last;
}
@@ -87,7 +87,7 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
if (!canRemove) {
throw new IllegalStateException("Iterator remove() can only be called once after next()");
}
- decorated.remove();
+ iterator.remove();
last = null;
canRemove = false;
}
@@ -164,6 +164,9 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
*/
protected static class MultiSetEntry<E> extends AbstractEntry<E> {
+ /**
+ * The parent entry.
+ */
protected final Map.Entry<E, MutableInteger> parentEntry;
/**
(commons-collections) 01/18: Remove redundant keywords
Posted by gg...@apache.org.
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 c788e536a964bfc6112df6f2ae204a93dc25e820
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 16:18:24 2024 -0400
Remove redundant keywords
---
.../commons/collections4/FluentIterable.java | 2 +-
.../apache/commons/collections4/SplitMapUtils.java | 4 +-
.../bloomfilter/ArrayCountingBloomFilter.java | 2 +-
.../collections4/bloomfilter/LayerManager.java | 4 +-
.../bloomfilter/SparseBloomFilter.java | 10 ++--
.../comparators/BooleanComparator.java | 2 +-
.../collections4/comparators/NullComparator.java | 10 ++--
.../comparators/TransformingComparator.java | 6 +-
.../collections4/iterators/ArrayIterator.java | 6 +-
.../collections4/iterators/ArrayListIterator.java | 20 +++----
.../iterators/ObjectArrayIterator.java | 18 +++---
.../iterators/ObjectArrayListIterator.java | 20 +++----
.../collections4/map/AbstractReferenceMap.java | 14 ++---
.../commons/collections4/map/CompositeMap.java | 64 +++++++++++-----------
.../commons/collections4/map/ListOrderedMap.java | 26 ++++-----
.../multimap/AbstractListValuedMap.java | 6 +-
.../commons/collections4/set/CompositeSet.java | 2 +-
.../commons/collections4/map/AbstractMapTest.java | 12 ++--
.../commons/collections4/map/CompositeMapTest.java | 2 +-
.../multimap/AbstractMultiValuedMapTest.java | 8 +--
20 files changed, 119 insertions(+), 119 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/FluentIterable.java b/src/main/java/org/apache/commons/collections4/FluentIterable.java
index 4a7054eb4..d3b07b88a 100644
--- a/src/main/java/org/apache/commons/collections4/FluentIterable.java
+++ b/src/main/java/org/apache/commons/collections4/FluentIterable.java
@@ -131,7 +131,7 @@ public class FluentIterable<E> implements Iterable<E> {
* Don't allow instances.
*/
FluentIterable() {
- this.iterable = this;
+ iterable = this;
}
/**
diff --git a/src/main/java/org/apache/commons/collections4/SplitMapUtils.java b/src/main/java/org/apache/commons/collections4/SplitMapUtils.java
index b645d3049..bcaca1a53 100644
--- a/src/main/java/org/apache/commons/collections4/SplitMapUtils.java
+++ b/src/main/java/org/apache/commons/collections4/SplitMapUtils.java
@@ -70,7 +70,7 @@ public class SplitMapUtils {
if (arg0 == this) {
return true;
}
- return arg0 instanceof WrappedGet && ((WrappedGet<?, ?>) arg0).get.equals(this.get);
+ return arg0 instanceof WrappedGet && ((WrappedGet<?, ?>) arg0).get.equals(get);
}
@Override
@@ -162,7 +162,7 @@ public class SplitMapUtils {
if (obj == this) {
return true;
}
- return obj instanceof WrappedPut && ((WrappedPut<?, ?>) obj).put.equals(this.put);
+ return obj instanceof WrappedPut && ((WrappedPut<?, ?>) obj).put.equals(put);
}
@Override
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java
index f5fc946a5..dc029d231 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/ArrayCountingBloomFilter.java
@@ -157,7 +157,7 @@ public final class ArrayCountingBloomFilter implements CountingBloomFilter {
@Override
public boolean contains(final IndexExtractor indexExtractor) {
- return indexExtractor.processIndices(idx -> this.cells[idx] != 0);
+ return indexExtractor.processIndices(idx -> cells[idx] != 0);
}
@Override
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
index 574a92cfb..2755a0ba0 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
@@ -326,7 +326,7 @@ public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor
* @see LayerManager.Builder#setCleanup(Consumer)
*/
void cleanup() {
- this.filterCleanup.accept(filters);
+ filterCleanup.accept(filters);
if (filters.isEmpty()) {
addFilter();
}
@@ -429,7 +429,7 @@ public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor
* @see LayerManager.Builder#setCleanup(Consumer)
*/
void next() {
- this.filterCleanup.accept(filters);
+ filterCleanup.accept(filters);
addFilter();
}
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/SparseBloomFilter.java b/src/main/java/org/apache/commons/collections4/bloomfilter/SparseBloomFilter.java
index 78b415fa8..746d86089 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/SparseBloomFilter.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/SparseBloomFilter.java
@@ -138,14 +138,14 @@ public final class SparseBloomFilter implements BloomFilter {
public boolean merge(final IndexExtractor indexExtractor) {
Objects.requireNonNull(indexExtractor, "indexExtractor");
indexExtractor.processIndices(this::add);
- if (!this.indices.isEmpty()) {
- if (this.indices.last() >= shape.getNumberOfBits()) {
+ if (!indices.isEmpty()) {
+ if (indices.last() >= shape.getNumberOfBits()) {
throw new IllegalArgumentException(String.format("Value in list %s is greater than maximum value (%s)",
- this.indices.last(), shape.getNumberOfBits() - 1));
+ indices.last(), shape.getNumberOfBits() - 1));
}
- if (this.indices.first() < 0) {
+ if (indices.first() < 0) {
throw new IllegalArgumentException(
- String.format("Value in list %s is less than 0", this.indices.first()));
+ String.format("Value in list %s is less than 0", indices.first()));
}
}
return true;
diff --git a/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java b/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java
index 6df3e1ed2..749456d44 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/BooleanComparator.java
@@ -157,7 +157,7 @@ public final class BooleanComparator implements Comparator<Boolean>, Serializabl
public boolean equals(final Object object) {
return this == object ||
object instanceof BooleanComparator &&
- this.trueFirst == ((BooleanComparator) object).trueFirst;
+ trueFirst == ((BooleanComparator) object).trueFirst;
}
/**
diff --git a/src/main/java/org/apache/commons/collections4/comparators/NullComparator.java b/src/main/java/org/apache/commons/collections4/comparators/NullComparator.java
index 3530959d3..8db6b07b7 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/NullComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/NullComparator.java
@@ -134,12 +134,12 @@ public class NullComparator<E> implements Comparator<E>, Serializable {
return 0;
}
if (o1 == null) {
- return this.nullsAreHigh ? 1 : -1;
+ return nullsAreHigh ? 1 : -1;
}
if (o2 == null) {
- return this.nullsAreHigh ? -1 : 1;
+ return nullsAreHigh ? -1 : 1;
}
- return this.nonNullComparator.compare(o1, o2);
+ return nonNullComparator.compare(o1, o2);
}
/**
@@ -167,8 +167,8 @@ public class NullComparator<E> implements Comparator<E>, Serializable {
final NullComparator<?> other = (NullComparator<?>) obj;
- return this.nullsAreHigh == other.nullsAreHigh &&
- this.nonNullComparator.equals(other.nonNullComparator);
+ return nullsAreHigh == other.nullsAreHigh &&
+ nonNullComparator.equals(other.nonNullComparator);
}
/**
diff --git a/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java b/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
index 5d6b18027..989334022 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/TransformingComparator.java
@@ -81,9 +81,9 @@ public class TransformingComparator<I, O> implements Comparator<I>, Serializable
*/
@Override
public int compare(final I obj1, final I obj2) {
- final O value1 = this.transformer.apply(obj1);
- final O value2 = this.transformer.apply(obj2);
- return this.decorated.compare(value1, value2);
+ final O value1 = transformer.apply(obj1);
+ final O value2 = transformer.apply(obj2);
+ return decorated.compare(value1, value2);
}
/**
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 393e63b81..c0f7bfd4d 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/ArrayIterator.java
@@ -137,7 +137,7 @@ public class ArrayIterator<E> implements ResettableIterator<E> {
* @since 4.0
*/
public int getEndIndex() {
- return this.endIndex;
+ return endIndex;
}
/**
@@ -147,7 +147,7 @@ public class ArrayIterator<E> implements ResettableIterator<E> {
* @since 4.0
*/
public int getStartIndex() {
- return this.startIndex;
+ return startIndex;
}
// Iterator interface
@@ -192,7 +192,7 @@ public class ArrayIterator<E> implements ResettableIterator<E> {
*/
@Override
public void reset() {
- this.index = this.startIndex;
+ index = startIndex;
}
}
diff --git a/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java
index 260c236f1..ed0c80664 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/ArrayListIterator.java
@@ -113,7 +113,7 @@ public class ArrayListIterator<E> extends ArrayIterator<E>
*/
@Override
public boolean hasPrevious() {
- return this.index > this.startIndex;
+ return index > startIndex;
}
/**
@@ -128,8 +128,8 @@ public class ArrayListIterator<E> extends ArrayIterator<E>
if (!hasNext()) {
throw new NoSuchElementException();
}
- this.lastItemIndex = this.index;
- return (E) Array.get(this.array, this.index++);
+ lastItemIndex = index;
+ return (E) Array.get(array, index++);
}
/**
@@ -139,7 +139,7 @@ public class ArrayListIterator<E> extends ArrayIterator<E>
*/
@Override
public int nextIndex() {
- return this.index - this.startIndex;
+ return index - startIndex;
}
/**
@@ -154,8 +154,8 @@ public class ArrayListIterator<E> extends ArrayIterator<E>
if (!hasPrevious()) {
throw new NoSuchElementException();
}
- this.lastItemIndex = --this.index;
- return (E) Array.get(this.array, this.index);
+ lastItemIndex = --index;
+ return (E) Array.get(array, index);
}
/**
@@ -165,7 +165,7 @@ public class ArrayListIterator<E> extends ArrayIterator<E>
*/
@Override
public int previousIndex() {
- return this.index - this.startIndex - 1;
+ return index - startIndex - 1;
}
/**
@@ -174,7 +174,7 @@ public class ArrayListIterator<E> extends ArrayIterator<E>
@Override
public void reset() {
super.reset();
- this.lastItemIndex = -1;
+ lastItemIndex = -1;
}
/**
@@ -197,11 +197,11 @@ public class ArrayListIterator<E> extends ArrayIterator<E>
*/
@Override
public void set(final Object o) {
- if (this.lastItemIndex == -1) {
+ if (lastItemIndex == -1) {
throw new IllegalStateException("must call next() or previous() before a call to set()");
}
- Array.set(this.array, this.lastItemIndex, o);
+ Array.set(array, lastItemIndex, o);
}
}
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 6f92abbb0..3a8b324a3 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayIterator.java
@@ -92,9 +92,9 @@ public class ObjectArrayIterator<E> implements ResettableIterator<E> {
throw new IllegalArgumentException("End index must not be less than start index");
}
this.array = array;
- this.startIndex = start;
- this.endIndex = end;
- this.index = start;
+ startIndex = start;
+ endIndex = end;
+ index = start;
}
/**
@@ -103,7 +103,7 @@ public class ObjectArrayIterator<E> implements ResettableIterator<E> {
* @return the array this iterator iterates over
*/
public E[] getArray() {
- return this.array;
+ return array;
}
/**
@@ -112,7 +112,7 @@ public class ObjectArrayIterator<E> implements ResettableIterator<E> {
* @return the end index
*/
public int getEndIndex() {
- return this.endIndex;
+ return endIndex;
}
/**
@@ -121,7 +121,7 @@ public class ObjectArrayIterator<E> implements ResettableIterator<E> {
* @return the start index
*/
public int getStartIndex() {
- return this.startIndex;
+ return startIndex;
}
/**
@@ -131,7 +131,7 @@ public class ObjectArrayIterator<E> implements ResettableIterator<E> {
*/
@Override
public boolean hasNext() {
- return this.index < this.endIndex;
+ return index < endIndex;
}
/**
@@ -146,7 +146,7 @@ public class ObjectArrayIterator<E> implements ResettableIterator<E> {
if (!hasNext()) {
throw new NoSuchElementException();
}
- return this.array[this.index++];
+ return array[index++];
}
/**
@@ -164,7 +164,7 @@ public class ObjectArrayIterator<E> implements ResettableIterator<E> {
*/
@Override
public void reset() {
- this.index = this.startIndex;
+ index = startIndex;
}
}
diff --git a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
index 419b1825f..faafa5703 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/ObjectArrayListIterator.java
@@ -105,7 +105,7 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
*/
@Override
public boolean hasPrevious() {
- return this.index > getStartIndex();
+ return index > getStartIndex();
}
/**
@@ -119,8 +119,8 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
if (!hasNext()) {
throw new NoSuchElementException();
}
- this.lastItemIndex = this.index;
- return this.array[this.index++];
+ lastItemIndex = index;
+ return array[index++];
}
/**
@@ -130,7 +130,7 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
*/
@Override
public int nextIndex() {
- return this.index - getStartIndex();
+ return index - getStartIndex();
}
/**
@@ -144,8 +144,8 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
if (!hasPrevious()) {
throw new NoSuchElementException();
}
- this.lastItemIndex = --this.index;
- return this.array[this.index];
+ lastItemIndex = --index;
+ return array[index];
}
/**
@@ -155,7 +155,7 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
*/
@Override
public int previousIndex() {
- return this.index - getStartIndex() - 1;
+ return index - getStartIndex() - 1;
}
/**
@@ -164,7 +164,7 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
@Override
public void reset() {
super.reset();
- this.lastItemIndex = -1;
+ lastItemIndex = -1;
}
/**
@@ -186,11 +186,11 @@ public class ObjectArrayListIterator<E> extends ObjectArrayIterator<E>
*/
@Override
public void set(final E obj) {
- if (this.lastItemIndex == -1) {
+ if (lastItemIndex == -1) {
throw new IllegalStateException("must call next() or previous() before a call to set()");
}
- this.array[this.lastItemIndex] = obj;
+ array[lastItemIndex] = obj;
}
}
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 632233495..0f926a474 100644
--- a/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
@@ -797,10 +797,10 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V>
@Override
@SuppressWarnings("unchecked")
protected void doReadObject(final ObjectInputStream in) throws IOException, ClassNotFoundException {
- this.keyType = ReferenceStrength.resolve(in.readInt());
- this.valueType = ReferenceStrength.resolve(in.readInt());
- this.purgeValues = in.readBoolean();
- this.loadFactor = in.readFloat();
+ keyType = ReferenceStrength.resolve(in.readInt());
+ valueType = ReferenceStrength.resolve(in.readInt());
+ purgeValues = in.readBoolean();
+ loadFactor = in.readFloat();
final int capacity = in.readInt();
init();
data = new HashEntry[capacity];
@@ -958,7 +958,7 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V>
* @return true if keyType has the specified type
*/
protected boolean isKeyType(final ReferenceStrength type) {
- return this.keyType == type;
+ return keyType == type;
}
/**
@@ -967,7 +967,7 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V>
* @return true if valueType has the specified type
*/
protected boolean isValueType(final ReferenceStrength type) {
- return this.valueType == type;
+ return valueType == type;
}
/**
@@ -1031,7 +1031,7 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V>
} else {
previous.next = entry.next;
}
- this.size--;
+ size--;
refEntry.onPurge();
return;
}
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 5ad29f248..6cb79c067 100644
--- a/src/main/java/org/apache/commons/collections4/map/CompositeMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/CompositeMap.java
@@ -193,17 +193,17 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
public synchronized void addComposited(final Map<K, V> map) throws IllegalArgumentException {
if (map != null) {
for (int i = composite.length - 1; i >= 0; --i) {
- final Collection<K> intersect = CollectionUtils.intersection(this.composite[i].keySet(), map.keySet());
+ final Collection<K> intersect = CollectionUtils.intersection(composite[i].keySet(), map.keySet());
if (!intersect.isEmpty()) {
- if (this.mutator == null) {
+ if (mutator == null) {
throw new IllegalArgumentException("Key collision adding Map to CompositeMap");
}
- this.mutator.resolveCollision(this, this.composite[i], map, intersect);
+ mutator.resolveCollision(this, composite[i], map, intersect);
}
}
- final Map<K, V>[] temp = Arrays.copyOf(this.composite, this.composite.length + 1);
+ final Map<K, V>[] temp = Arrays.copyOf(composite, composite.length + 1);
temp[temp.length - 1] = map;
- this.composite = temp;
+ composite = temp;
}
}
@@ -214,8 +214,8 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
*/
@Override
public void clear() {
- for (int i = this.composite.length - 1; i >= 0; --i) {
- this.composite[i].clear();
+ for (int i = composite.length - 1; i >= 0; --i) {
+ composite[i].clear();
}
}
@@ -237,8 +237,8 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
*/
@Override
public boolean containsKey(final Object key) {
- for (int i = this.composite.length - 1; i >= 0; --i) {
- if (this.composite[i].containsKey(key)) {
+ for (int i = composite.length - 1; i >= 0; --i) {
+ if (composite[i].containsKey(key)) {
return true;
}
}
@@ -263,8 +263,8 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
*/
@Override
public boolean containsValue(final Object value) {
- for (int i = this.composite.length - 1; i >= 0; --i) {
- if (this.composite[i].containsValue(value)) {
+ for (int i = composite.length - 1; i >= 0; --i) {
+ if (composite[i].containsValue(value)) {
return true;
}
}
@@ -338,9 +338,9 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
*/
@Override
public V get(final Object key) {
- for (int i = this.composite.length - 1; i >= 0; --i) {
- if (this.composite[i].containsKey(key)) {
- return this.composite[i].get(key);
+ for (int i = composite.length - 1; i >= 0; --i) {
+ if (composite[i].containsKey(key)) {
+ return composite[i].get(key);
}
}
return null;
@@ -366,8 +366,8 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
*/
@Override
public boolean isEmpty() {
- for (int i = this.composite.length - 1; i >= 0; --i) {
- if (!this.composite[i].isEmpty()) {
+ for (int i = composite.length - 1; i >= 0; --i) {
+ if (!composite[i].isEmpty()) {
return false;
}
}
@@ -392,8 +392,8 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
@Override
public Set<K> keySet() {
final CompositeSet<K> keys = new CompositeSet<>();
- for (int i = this.composite.length - 1; i >= 0; --i) {
- keys.addComposited(this.composite[i].keySet());
+ for (int i = composite.length - 1; i >= 0; --i) {
+ keys.addComposited(composite[i].keySet());
}
return keys;
}
@@ -425,10 +425,10 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
*/
@Override
public V put(final K key, final V value) {
- if (this.mutator == null) {
+ if (mutator == null) {
throw new UnsupportedOperationException("No mutator specified");
}
- return this.mutator.put(this, this.composite, key, value);
+ return mutator.put(this, composite, key, value);
}
/**
@@ -455,10 +455,10 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
*/
@Override
public void putAll(final Map<? extends K, ? extends V> map) {
- if (this.mutator == null) {
+ if (mutator == null) {
throw new UnsupportedOperationException("No mutator specified");
}
- this.mutator.putAll(this, this.composite, map);
+ mutator.putAll(this, composite, map);
}
/**
@@ -488,9 +488,9 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
*/
@Override
public V remove(final Object key) {
- for (int i = this.composite.length - 1; i >= 0; --i) {
- if (this.composite[i].containsKey(key)) {
- return this.composite[i].remove(key);
+ for (int i = composite.length - 1; i >= 0; --i) {
+ if (composite[i].containsKey(key)) {
+ return composite[i].remove(key);
}
}
return null;
@@ -504,13 +504,13 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
*/
@SuppressWarnings("unchecked")
public synchronized Map<K, V> removeComposited(final Map<K, V> map) {
- final int size = this.composite.length;
+ final int size = composite.length;
for (int i = 0; i < size; ++i) {
- if (this.composite[i].equals(map)) {
+ if (composite[i].equals(map)) {
final Map<K, V>[] temp = new Map[size - 1];
- System.arraycopy(this.composite, 0, temp, 0, i);
- System.arraycopy(this.composite, i + 1, temp, i, size - i - 1);
- this.composite = temp;
+ System.arraycopy(composite, 0, temp, 0, i);
+ System.arraycopy(composite, i + 1, temp, i, size - i - 1);
+ composite = temp;
return map;
}
}
@@ -536,8 +536,8 @@ public class CompositeMap<K, V> extends AbstractIterableMap<K, V> implements Ser
@Override
public int size() {
int size = 0;
- for (int i = this.composite.length - 1; i >= 0; --i) {
- size += this.composite[i].size();
+ for (int i = composite.length - 1; i >= 0; --i) {
+ size += composite[i].size();
}
return size;
}
diff --git a/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java b/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java
index 21937e836..f08dcb1af 100644
--- a/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/ListOrderedMap.java
@@ -97,7 +97,7 @@ public class ListOrderedMap<K, V>
@Override
public void clear() {
- this.parent.clear();
+ parent.clear();
}
@Override
@@ -131,7 +131,7 @@ public class ListOrderedMap<K, V>
@Override
public boolean isEmpty() {
- return this.parent.isEmpty();
+ return parent.isEmpty();
}
@Override
@@ -155,7 +155,7 @@ public class ListOrderedMap<K, V>
@Override
public int size() {
- return this.parent.size();
+ return parent.size();
}
@Override
@@ -174,12 +174,12 @@ public class ListOrderedMap<K, V>
@Override
public void clear() {
- this.parent.clear();
+ parent.clear();
}
@Override
public boolean contains(final Object value) {
- return this.parent.containsKey(value);
+ return parent.containsKey(value);
}
@Override
@@ -194,7 +194,7 @@ public class ListOrderedMap<K, V>
@Override
public int size() {
- return this.parent.size();
+ return parent.size();
}
}
@@ -334,17 +334,17 @@ public class ListOrderedMap<K, V>
@Override
public void clear() {
- this.parent.clear();
+ parent.clear();
}
@Override
public boolean contains(final Object value) {
- return this.parent.containsValue(value);
+ return parent.containsValue(value);
}
@Override
public V get(final int index) {
- return this.parent.getValue(index);
+ return parent.getValue(index);
}
@Override
@@ -359,17 +359,17 @@ public class ListOrderedMap<K, V>
@Override
public V remove(final int index) {
- return this.parent.remove(index);
+ return parent.remove(index);
}
@Override
public V set(final int index, final V value) {
- return this.parent.setValue(index, value);
+ return parent.setValue(index, value);
}
@Override
public int size() {
- return this.parent.size();
+ return parent.size();
}
}
@@ -452,7 +452,7 @@ public class ListOrderedMap<K, V>
*/
@Override
public Set<Map.Entry<K, V>> entrySet() {
- return new EntrySetView<>(this, this.insertOrder);
+ return new EntrySetView<>(this, insertOrder);
}
/**
diff --git a/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java b/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
index 95f05ec79..bae286526 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/AbstractListValuedMap.java
@@ -64,10 +64,10 @@ public abstract class AbstractListValuedMap<K, V> extends AbstractMultiValuedMap
if (getMap().get(key) == null) {
final List<V> list = createCollection();
getMap().put(key, list);
- this.values = list;
- this.iterator = list.listIterator();
+ values = list;
+ iterator = list.listIterator();
}
- this.iterator.add(value);
+ iterator.add(value);
}
@Override
diff --git a/src/main/java/org/apache/commons/collections4/set/CompositeSet.java b/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
index 3d52484f6..05f6596f6 100644
--- a/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
+++ b/src/main/java/org/apache/commons/collections4/set/CompositeSet.java
@@ -194,7 +194,7 @@ public class CompositeSet<E> implements Set<E>, Serializable {
for (final Set<E> existingSet : getSets()) {
final Collection<E> intersects = CollectionUtils.intersection(existingSet, set);
if (!intersects.isEmpty()) {
- if (this.mutator == null) {
+ if (mutator == null) {
throw new UnsupportedOperationException(
"Collision adding composited set with no SetMutator set");
}
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 717d599da..7b7fa7503 100644
--- a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
@@ -843,18 +843,18 @@ public abstract class AbstractMapTest<K, V> extends AbstractObjectTest {
* Resets the {@link #map}, {@link #entrySet}, {@link #keySet}, {@link #values} and {@link #confirmed} fields to empty.
*/
public void resetEmpty() {
- this.map = makeObject();
+ map = makeObject();
views();
- this.confirmed = makeConfirmedMap();
+ confirmed = makeConfirmedMap();
}
/**
* Resets the {@link #map}, {@link #entrySet}, {@link #keySet}, {@link #values} and {@link #confirmed} fields to full.
*/
public void resetFull() {
- this.map = makeFullMap();
+ map = makeFullMap();
views();
- this.confirmed = makeConfirmedMap();
+ confirmed = makeConfirmedMap();
final K[] k = getSampleKeys();
final V[] v = getSampleValues();
for (int i = 0; i < k.length; i++) {
@@ -1920,10 +1920,10 @@ public abstract class AbstractMapTest<K, V> extends AbstractObjectTest {
* Resets the collection view fields.
*/
private void views() {
- this.keySet = getMap().keySet();
+ keySet = getMap().keySet();
// see verifyValues: retrieve the values collection only when verifying them
// this.values = getMap().values();
- this.entrySet = getMap().entrySet();
+ entrySet = getMap().entrySet();
}
}
diff --git a/src/test/java/org/apache/commons/collections4/map/CompositeMapTest.java b/src/test/java/org/apache/commons/collections4/map/CompositeMapTest.java
index 092525215..2ea551129 100644
--- a/src/test/java/org/apache/commons/collections4/map/CompositeMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/CompositeMapTest.java
@@ -72,7 +72,7 @@ public class CompositeMapTest<K, V> extends AbstractIterableMapTest<K, V> {
@BeforeEach
public void setUp() throws Exception {
- this.pass = false;
+ pass = false;
}
@Test
diff --git a/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java b/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java
index f4d368287..fd0e7b42d 100644
--- a/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java
@@ -669,16 +669,16 @@ public abstract class AbstractMultiValuedMapTest<K, V> extends AbstractObjectTes
* Resets the {@link #map} and {@link #confirmed} fields to empty.
*/
public void resetEmpty() {
- this.map = makeObject();
- this.confirmed = makeConfirmedMap();
+ map = makeObject();
+ confirmed = makeConfirmedMap();
}
/**
* Resets the {@link #map} and {@link #confirmed} fields to full.
*/
public void resetFull() {
- this.map = makeFullMap();
- this.confirmed = makeConfirmedMap();
+ map = makeFullMap();
+ confirmed = makeConfirmedMap();
final K[] k = getSampleKeys();
final V[] v = getSampleValues();
for (int i = 0; i < k.length; i++) {
(commons-collections) 10/18: Javadoc
Posted by gg...@apache.org.
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 2ae865abc2a70e5b7f6af99374d2c61ad5646814
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 17:54:17 2024 -0400
Javadoc
---
.../collections4/bidimap/DualTreeBidiMap.java | 11 ++++++
.../comparators/FixedOrderComparator.java | 19 ++++++++--
.../collections4/functors/ComparatorPredicate.java | 31 +++++++++++++++--
.../collections4/list/AbstractLinkedList.java | 25 +++++++++++---
.../collections4/map/AbstractHashedMap.java | 40 ++++++++++++++++++++++
.../collections4/map/AbstractReferenceMap.java | 18 ++++++++--
.../collections4/trie/AbstractBitwiseTrie.java | 10 ++++++
.../collections4/trie/AbstractPatriciaTrie.java | 34 ++++++++++++------
.../commons/collections4/trie/KeyAnalyzer.java | 5 ++-
.../collections4/trie/UnmodifiableTrie.java | 3 ++
10 files changed, 173 insertions(+), 23 deletions(-)
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 50d49d5d7..5d51c62db 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/DualTreeBidiMap.java
@@ -322,10 +322,20 @@ public class DualTreeBidiMap<K, V> extends AbstractDualBidiMap<K, V>
return (SortedBidiMap<V, K>) super.inverseBidiMap();
}
+ /**
+ * Defaults to {@link #inverseBidiMap()}.
+ *
+ * @return Defaults to {@link #inverseBidiMap()}.
+ */
public OrderedBidiMap<V, K> inverseOrderedBidiMap() {
return inverseBidiMap();
}
+ /**
+ * Defaults to {@link #inverseBidiMap()}.
+ *
+ * @return Defaults to {@link #inverseBidiMap()}.
+ */
public SortedBidiMap<V, K> inverseSortedBidiMap() {
return inverseBidiMap();
}
@@ -340,6 +350,7 @@ public class DualTreeBidiMap<K, V> extends AbstractDualBidiMap<K, V>
* <p>
* This implementation copies the elements to an ArrayList in order to
* provide the forward/backward behavior.
+ * </p>
*
* @return a new ordered map iterator
*/
diff --git a/src/main/java/org/apache/commons/collections4/comparators/FixedOrderComparator.java b/src/main/java/org/apache/commons/collections4/comparators/FixedOrderComparator.java
index 6cd77f3c5..0952beea0 100644
--- a/src/main/java/org/apache/commons/collections4/comparators/FixedOrderComparator.java
+++ b/src/main/java/org/apache/commons/collections4/comparators/FixedOrderComparator.java
@@ -53,11 +53,26 @@ import java.util.Objects;
public class FixedOrderComparator<T> implements Comparator<T>, Serializable {
/**
- * Unknown object behavior enum.
+ * Enumerates the unknown object behaviors.
+ *
* @since 4.0
*/
public enum UnknownObjectBehavior {
- BEFORE, AFTER, EXCEPTION
+
+ /**
+ * Before unknown object behaviors.
+ */
+ BEFORE,
+
+ /**
+ * After unknown object behaviors.
+ */
+ AFTER,
+
+ /**
+ * Exception unknown object behaviors.
+ */
+ EXCEPTION
}
/** Serialization version from Collections 4.0. */
diff --git a/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java b/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java
index d42cb9732..8c8aca39e 100644
--- a/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java
+++ b/src/main/java/org/apache/commons/collections4/functors/ComparatorPredicate.java
@@ -79,14 +79,39 @@ import org.apache.commons.collections4.Predicate;
*/
public class ComparatorPredicate<T> extends AbstractPredicate<T> implements Serializable {
+ /**
+ * Enumerates the comparator criteria.
+ */
public enum Criterion {
- EQUAL, GREATER, LESS, GREATER_OR_EQUAL, LESS_OR_EQUAL,
+
+ /**
+ * Equal criterion.
+ */
+ EQUAL,
+
+ /**
+ * Greater criterion.
+ */
+ GREATER,
+
+ /**
+ * Less criterion.
+ */
+ LESS,
+
+ /**
+ * Greater or equal criterion.
+ */
+ GREATER_OR_EQUAL,
+
+ /**
+ * Less or equal Criterion.
+ */
+ LESS_OR_EQUAL,
}
private static final long serialVersionUID = -1863209236504077399L;
- // Instance variables:
-
/**
* Factory to create the comparator predicate
*
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 0a941b6e4..68353e82b 100644
--- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
@@ -101,9 +101,9 @@ public abstract class AbstractLinkedList<E> implements List<E> {
/**
* Create a ListIterator for a list.
*
- * @param parent the parent list
- * @param fromIndex the index to start at
- * @throws IndexOutOfBoundsException if fromIndex is less than 0 or greater than the size of the list
+ * @param parent the parent list.
+ * @param fromIndex The starting index.
+ * @throws IndexOutOfBoundsException if fromIndex is less than 0 or greater than the size of the list.
*/
protected LinkedListIterator(final AbstractLinkedList<E> parent, final int fromIndex)
throws IndexOutOfBoundsException {
@@ -226,15 +226,26 @@ public abstract class AbstractLinkedList<E> implements List<E> {
* @param <E> the type of elements in this list.
*/
protected static class LinkedSubList<E> extends AbstractList<E> {
+
/** The main list */
AbstractLinkedList<E> parent;
+
/** Offset from the main list */
int offset;
+
/** Sublist size */
int size;
+
/** Sublist modCount */
int expectedModCount;
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractLinkedList.
+ * @param fromIndex An index greater or equal to 0 and less than {@code toIndex}.
+ * @param toIndex An index greater than {@code fromIndex}.
+ */
protected LinkedSubList(final AbstractLinkedList<E> parent, final int fromIndex, final int toIndex) {
if (fromIndex < 0) {
throw new IndexOutOfBoundsException("fromIndex = " + fromIndex);
@@ -361,9 +372,15 @@ public abstract class AbstractLinkedList<E> implements List<E> {
*/
protected static class LinkedSubListIterator<E> extends LinkedListIterator<E> {
- /** The sub list */
+ /** The sub list. */
protected final LinkedSubList<E> sub;
+ /**
+ * Constructs a new instance.
+ *
+ * @param sub The sub-list.
+ * @param startIndex The starting index.
+ */
protected LinkedSubListIterator(final LinkedSubList<E> sub, final int startIndex) {
super(sub.parent, startIndex + sub.offset);
this.sub = sub;
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 8994c36d7..fcc86d401 100644
--- a/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java
@@ -168,6 +168,14 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
/** The value */
protected Object value;
+ /**
+ * Constructs a new instance.
+ *
+ * @param next next.
+ * @param hashCode hash code.
+ * @param key key.
+ * @param value value.
+ */
protected HashEntry(final HashEntry<K, V> next, final int hashCode, final Object key, final V value) {
this.next = next;
this.hashCode = hashCode;
@@ -246,6 +254,11 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
/** The modification count expected */
private int expectedModCount;
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractHashedMap.
+ */
protected HashIterator(final AbstractHashedMap<K, V> parent) {
this.parent = parent;
final HashEntry<K, V>[] data = parent.data;
@@ -316,6 +329,11 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
*/
protected static class HashMapIterator<K, V> extends HashIterator<K, V> implements MapIterator<K, V> {
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractHashedMap.
+ */
protected HashMapIterator(final AbstractHashedMap<K, V> parent) {
super(parent);
}
@@ -359,9 +377,15 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
* @param <K> the type of elements maintained by this set
*/
protected static class KeySet<K> extends AbstractSet<K> {
+
/** The parent map */
private final AbstractHashedMap<K, ?> parent;
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractHashedMap.
+ */
protected KeySet(final AbstractHashedMap<K, ?> parent) {
this.parent = parent;
}
@@ -401,6 +425,11 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
*/
protected static class KeySetIterator<K> extends HashIterator<K, Object> implements Iterator<K> {
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractHashedMap.
+ */
@SuppressWarnings("unchecked")
protected KeySetIterator(final AbstractHashedMap<K, ?> parent) {
super((AbstractHashedMap<K, Object>) parent);
@@ -418,9 +447,15 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
* @param <V> the type of elements maintained by this collection
*/
protected static class Values<V> extends AbstractCollection<V> {
+
/** The parent map */
private final AbstractHashedMap<?, V> parent;
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractHashedMap.
+ */
protected Values(final AbstractHashedMap<?, V> parent) {
this.parent = parent;
}
@@ -453,6 +488,11 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
*/
protected static class ValuesIterator<V> extends HashIterator<Object, V> implements Iterator<V> {
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractHashedMap.
+ */
@SuppressWarnings("unchecked")
protected ValuesIterator(final AbstractHashedMap<?, V> parent) {
super((AbstractHashedMap<Object, V>) parent);
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 7ff279752..b6863b4c2 100644
--- a/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
@@ -495,10 +495,24 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V>
}
/**
- * Reference type enum.
+ * Enumerates reference types.
*/
public enum ReferenceStrength {
- HARD(0), SOFT(1), WEAK(2);
+
+ /**
+ * Hard reference type.
+ */
+ HARD(0),
+
+ /**
+ * Soft reference type.
+ */
+ SOFT(1),
+
+ /**
+ * Weak reference type.
+ */
+ WEAK(2);
/**
* Resolve enum from int.
diff --git a/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java b/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java
index 22445e4b1..bb87e0a5c 100644
--- a/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java
+++ b/src/main/java/org/apache/commons/collections4/trie/AbstractBitwiseTrie.java
@@ -41,8 +41,14 @@ public abstract class AbstractBitwiseTrie<K, V> extends AbstractMap<K, V>
private static final long serialVersionUID = -944364551314110330L;
+ /**
+ * The entry's key.
+ */
protected K key;
+ /**
+ * The entry's value.
+ */
protected V value;
BasicEntry(final K key) {
@@ -89,6 +95,10 @@ public abstract class AbstractBitwiseTrie<K, V> extends AbstractMap<K, V>
/**
* Replaces the current key and value with the provided key & value.
+ *
+ * @param key The new key.
+ * @param value The new value.
+ * @return The previous value.
*/
public V setKeyValue(final K key, final V value) {
this.key = key;
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 ea3d3801a..55175c9e9 100644
--- a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
+++ b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
@@ -996,11 +996,16 @@ public abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
/** The entry who uplinks to this entry. */
protected TrieEntry<K, V> predecessor;
+ /**
+ * Constructs a new instance.
+ *
+ * @param key The entry's key.
+ * @param value The entry's value.
+ * @param bitIndex The entry's bitIndex.
+ */
public TrieEntry(final K key, final V value, final int bitIndex) {
super(key, value);
-
this.bitIndex = bitIndex;
-
this.parent = null;
this.left = this;
this.right = null;
@@ -1008,23 +1013,29 @@ public abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
}
/**
- * Whether or not the entry is storing a key.
+ * Whether the entry is storing a key.
* Only the root can potentially be empty, all other
* nodes must have a key.
+ *
+ * @return Whether the entry is storing a key
*/
public boolean isEmpty() {
return key == null;
}
/**
- * Either the left or right child is a loopback.
+ * Whether the left or right child is a loopback.
+ *
+ * @return Whether the left or right child is a loopback.
*/
public boolean isExternalNode() {
return !isInternalNode();
}
/**
- * Neither the left nor right child is a loopback.
+ * Tests that neither the left nor right child is a loopback.
+ *
+ * @return That neither the left nor right child is a loopback.
*/
public boolean isInternalNode() {
return left != this && right != this;
@@ -1245,19 +1256,20 @@ public abstract class AbstractPatriciaTrie<K, V> extends AbstractBitwiseTrie<K,
/**
* Constructs a new {@link Trie} using the given {@link KeyAnalyzer}.
*
- * @param keyAnalyzer the {@link KeyAnalyzer} to use
+ * @param keyAnalyzer the {@link KeyAnalyzer}.
*/
protected AbstractPatriciaTrie(final KeyAnalyzer<? super K> keyAnalyzer) {
super(keyAnalyzer);
}
/**
- * Constructs a new {@link org.apache.commons.collections4.Trie}
- * using the given {@link KeyAnalyzer} and initializes the {@link org.apache.commons.collections4.Trie}
- * with the values from the provided {@link Map}.
+ * Constructs a new {@link org.apache.commons.collections4.Trie} using the given {@link KeyAnalyzer} and initializes the
+ * {@link org.apache.commons.collections4.Trie} with the values from the provided {@link Map}.
+ *
+ * @param keyAnalyzer the {@link KeyAnalyzer}.
+ * @param map The source map.
*/
- protected AbstractPatriciaTrie(final KeyAnalyzer<? super K> keyAnalyzer,
- final Map<? extends K, ? extends V> map) {
+ protected AbstractPatriciaTrie(final KeyAnalyzer<? super K> keyAnalyzer, final Map<? extends K, ? extends V> map) {
super(keyAnalyzer);
putAll(map);
}
diff --git a/src/main/java/org/apache/commons/collections4/trie/KeyAnalyzer.java b/src/main/java/org/apache/commons/collections4/trie/KeyAnalyzer.java
index 9b8c8fef6..a6dfd7707 100644
--- a/src/main/java/org/apache/commons/collections4/trie/KeyAnalyzer.java
+++ b/src/main/java/org/apache/commons/collections4/trie/KeyAnalyzer.java
@@ -46,10 +46,13 @@ public abstract class KeyAnalyzer<K> implements Comparator<K>, Serializable {
/**
* Returned by {@link #bitIndex(Object, int, int, Object, int, int)} if key and found key are equal.
- * This is a very, very specific case and shouldn't happen on a regular basis.
+ * This is a very specific case and shouldn't happen on a regular basis.
*/
public static final int EQUAL_BIT_KEY = -2;
+ /**
+ * Used to test a {@code bitIndex} in {@link #isOutOfBoundsIndex(int)}.
+ */
public static final int OUT_OF_BOUNDS_BIT_KEY = -3;
/**
diff --git a/src/main/java/org/apache/commons/collections4/trie/UnmodifiableTrie.java b/src/main/java/org/apache/commons/collections4/trie/UnmodifiableTrie.java
index f89b23cd6..122330b7e 100644
--- a/src/main/java/org/apache/commons/collections4/trie/UnmodifiableTrie.java
+++ b/src/main/java/org/apache/commons/collections4/trie/UnmodifiableTrie.java
@@ -60,6 +60,9 @@ public class UnmodifiableTrie<K, V> implements Trie<K, V>, Serializable, Unmodif
return new UnmodifiableTrie<>(trie);
}
+ /**
+ * The delegate Trie.
+ */
private final Trie<K, V> delegate;
/**
(commons-collections) 12/18: Javadoc
Posted by gg...@apache.org.
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 e6b8bbd08faf0f37c7d79a64117f52f6d414a98d
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 18:12:05 2024 -0400
Javadoc
- Objects.requireNonNull()
- Whitespace
---
.../collections4/map/AbstractLinkedMap.java | 62 +++++++++++++++++++++-
.../multimap/AbstractMultiValuedMap.java | 10 +++-
.../collections4/multiset/AbstractMapMultiSet.java | 3 ++
3 files changed, 72 insertions(+), 3 deletions(-)
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 4c4cd71c9..e4b81ec86 100644
--- a/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/AbstractLinkedMap.java
@@ -20,6 +20,7 @@ import java.util.ConcurrentModificationException;
import java.util.Iterator;
import java.util.Map;
import java.util.NoSuchElementException;
+import java.util.Objects;
import org.apache.commons.collections4.OrderedIterator;
import org.apache.commons.collections4.OrderedMap;
@@ -77,6 +78,11 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
protected static class EntrySetIterator<K, V> extends LinkIterator<K, V> implements
OrderedIterator<Map.Entry<K, V>>, ResettableIterator<Map.Entry<K, V>> {
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractLinkedMap.
+ */
protected EntrySetIterator(final AbstractLinkedMap<K, V> parent) {
super(parent);
}
@@ -100,6 +106,11 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
protected static class KeySetIterator<K> extends LinkIterator<K, Object> implements
OrderedIterator<K>, ResettableIterator<K> {
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractLinkedMap.
+ */
@SuppressWarnings("unchecked")
protected KeySetIterator(final AbstractLinkedMap<K, ?> parent) {
super((AbstractLinkedMap<K, Object>) parent);
@@ -157,31 +168,59 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
/** The parent map */
protected final AbstractLinkedMap<K, V> parent;
+
/** The current (last returned) entry */
protected LinkEntry<K, V> last;
+
/** The next entry */
protected LinkEntry<K, V> next;
+
/** The modification count expected */
protected int expectedModCount;
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractLinkedMap.
+ */
protected LinkIterator(final AbstractLinkedMap<K, V> parent) {
- this.parent = parent;
+ this.parent = Objects.requireNonNull(parent);
this.next = parent.header.after;
this.expectedModCount = parent.modCount;
}
+ /**
+ * Gets the current entry.
+ *
+ * @return the current entry.
+ */
protected LinkEntry<K, V> currentEntry() {
return last;
}
+ /**
+ * Tests whether there is another entry.
+ *
+ * @return whether there is another entry.
+ */
public boolean hasNext() {
return next != parent.header;
}
+ /**
+ * Tests whether there is a previous entry.
+ *
+ * @return whether there is a previous entry.
+ */
public boolean hasPrevious() {
return next.before != parent.header;
}
+ /**
+ * Gets the next entry.
+ *
+ * @return the next entry.
+ */
protected LinkEntry<K, V> nextEntry() {
if (parent.modCount != expectedModCount) {
throw new ConcurrentModificationException();
@@ -194,6 +233,11 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
return last;
}
+ /**
+ * Gets the previous entry.
+ *
+ * @return the previous entry.
+ */
protected LinkEntry<K, V> previousEntry() {
if (parent.modCount != expectedModCount) {
throw new ConcurrentModificationException();
@@ -207,6 +251,9 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
return last;
}
+ /**
+ * Removes the current entry.
+ */
public void remove() {
if (last == null) {
throw new IllegalStateException(REMOVE_INVALID);
@@ -219,6 +266,9 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
expectedModCount = parent.modCount;
}
+ /**
+ * Resets the state to the end.
+ */
public void reset() {
last = null;
next = parent.header.after;
@@ -242,6 +292,11 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
protected static class LinkMapIterator<K, V> extends LinkIterator<K, V> implements
OrderedMapIterator<K, V>, ResettableIterator<K> {
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractLinkedMap.
+ */
protected LinkMapIterator(final AbstractLinkedMap<K, V> parent) {
super(parent);
}
@@ -292,6 +347,11 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im
protected static class ValuesIterator<V> extends LinkIterator<Object, V> implements
OrderedIterator<V>, ResettableIterator<V> {
+ /**
+ * Constructs a new instance.
+ *
+ * @param parent The parent AbstractLinkedMap.
+ */
@SuppressWarnings("unchecked")
protected ValuesIterator(final AbstractLinkedMap<?, V> parent) {
super((AbstractLinkedMap<Object, V>) parent);
diff --git a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
index 27a24b020..c869f3007 100644
--- a/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
+++ b/src/main/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMap.java
@@ -220,11 +220,12 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
*/
private final class KeysMultiSet extends AbstractMultiSet<K> {
- private final class MapEntryTransformer
- implements Transformer<Map.Entry<K, Collection<V>>, MultiSet.Entry<K>> {
+ private final class MapEntryTransformer implements Transformer<Map.Entry<K, Collection<V>>, MultiSet.Entry<K>> {
+
@Override
public MultiSet.Entry<K> transform(final Map.Entry<K, Collection<V>> mapEntry) {
return new AbstractMultiSet.AbstractEntry<K>() {
+
@Override
public int getCount() {
return mapEntry.getValue().size();
@@ -617,6 +618,11 @@ public abstract class AbstractMultiValuedMap<K, V> implements MultiValuedMap<K,
return values().contains(value);
}
+ /**
+ * Creates a new Collection typed for a given subclass.
+ *
+ * @return a new Collection typed for a given subclass.
+ */
protected abstract Collection<V> createCollection();
/**
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 a5e9ba259..98f81dddf 100644
--- a/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
+++ b/src/main/java/org/apache/commons/collections4/multiset/AbstractMapMultiSet.java
@@ -51,6 +51,9 @@ public abstract class AbstractMapMultiSet<E> extends AbstractMultiSet<E> {
/** The parent map */
protected final AbstractMapMultiSet<E> parent;
+ /**
+ * The source Iterator.
+ */
protected final Iterator<Map.Entry<E, MutableInteger>> iterator;
/** The last returned entry */
(commons-collections) 18/18: Push down null checks
Posted by gg...@apache.org.
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 edcc524215ee7fcee714be5243cc4ff7883c4254
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 18:56:10 2024 -0400
Push down null checks
- Use more language neutral exception message
- Use Objects.requireNonNull()
---
.../collections4/bloomfilter/LayerManager.java | 21 +++++++--------------
.../collections4/bloomfilter/LayerManagerTest.java | 8 ++++----
2 files changed, 11 insertions(+), 18 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
index 5e18f99ba..353c1f139 100644
--- a/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
+++ b/src/main/java/org/apache/commons/collections4/bloomfilter/LayerManager.java
@@ -76,9 +76,6 @@ public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor
* @return a new LayerManager.
*/
public LayerManager<T> build() {
- Objects.requireNonNull(supplier, "Supplier must not be null");
- Objects.requireNonNull(extendCheck, "ExtendCheck must not be null");
- Objects.requireNonNull(cleanup, "Cleanup must not be null");
return new LayerManager<>(supplier, extendCheck, cleanup, true);
}
@@ -291,19 +288,19 @@ public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor
/**
* Constructs a new instance.
*
- * @param filterSupplier the supplier of new Bloom filters to add the the list
+ * @param filterSupplier the non-null supplier of new Bloom filters to add the the list
* when necessary.
- * @param extendCheck The predicate that checks if a new filter should be
+ * @param extendCheck The non-null predicate that checks if a new filter should be
* added to the list.
- * @param filterCleanup the consumer that removes any old filters from the
+ * @param filterCleanup the non-null consumer that removes any old filters from the
* list.
* @param initialize true if the filter list should be initialized.
*/
private LayerManager(final Supplier<T> filterSupplier, final Predicate<LayerManager<T>> extendCheck,
final Consumer<Deque<T>> filterCleanup, final boolean initialize) {
- this.filterSupplier = filterSupplier;
- this.extendCheck = extendCheck;
- this.filterCleanup = filterCleanup;
+ this.filterSupplier = Objects.requireNonNull(filterSupplier, "filterSupplier");
+ this.extendCheck = Objects.requireNonNull(extendCheck, "extendCheck");
+ this.filterCleanup = Objects.requireNonNull(filterCleanup, "filterCleanup");
if (initialize) {
addFilter();
}
@@ -313,11 +310,7 @@ public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor
* Adds a new Bloom filter to the list.
*/
private void addFilter() {
- final T bf = filterSupplier.get();
- if (bf == null) {
- throw new NullPointerException("filterSupplier returned null.");
- }
- filters.add(bf);
+ filters.add(Objects.requireNonNull(filterSupplier.get(), "filterSupplier.get() returned null."));
}
/**
diff --git a/src/test/java/org/apache/commons/collections4/bloomfilter/LayerManagerTest.java b/src/test/java/org/apache/commons/collections4/bloomfilter/LayerManagerTest.java
index ca90f0d0d..5f03770c6 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/LayerManagerTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/LayerManagerTest.java
@@ -89,17 +89,17 @@ public class LayerManagerTest {
public void testBuilder() {
final LayerManager.Builder<BloomFilter> underTest = LayerManager.builder();
NullPointerException npe = assertThrows(NullPointerException.class, underTest::build);
- assertTrue(npe.getMessage().contains("Supplier must not be null"));
+ assertTrue(npe.getMessage().contains("filterSupplier"));
underTest.setSupplier(() -> null).setCleanup(null);
npe = assertThrows(NullPointerException.class, underTest::build);
- assertTrue(npe.getMessage().contains("Cleanup must not be null"));
+ assertTrue(npe.getMessage().contains("filterCleanup"));
underTest.setCleanup(x -> {
}).setExtendCheck(null);
npe = assertThrows(NullPointerException.class, underTest::build);
- assertTrue(npe.getMessage().contains("ExtendCheck must not be null"));
+ assertTrue(npe.getMessage().contains("extendCheck"));
npe = assertThrows(NullPointerException.class, () -> LayerManager.builder().setSupplier(() -> null).build());
- assertTrue(npe.getMessage().contains("filterSupplier returned null."));
+ assertTrue(npe.getMessage().contains("filterSupplier.get() returned null."));
}
(commons-collections) 09/18: Use java.time
Posted by gg...@apache.org.
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 a06dee1b3958b12714e5e92dce37e7aaac81102f
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 16:59:49 2024 -0400
Use java.time
---
.../bloomfilter/LayeredBloomFilterTest.java | 56 ++++++++++------------
1 file changed, 26 insertions(+), 30 deletions(-)
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 9bbb2ed51..ac698bba0 100644
--- a/src/test/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilterTest.java
+++ b/src/test/java/org/apache/commons/collections4/bloomfilter/LayeredBloomFilterTest.java
@@ -21,11 +21,12 @@ import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
+import java.time.Duration;
+import java.time.Instant;
import java.util.ArrayList;
import java.util.Deque;
import java.util.Iterator;
import java.util.List;
-import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.function.Supplier;
@@ -40,16 +41,16 @@ public class LayeredBloomFilterTest extends AbstractBloomFilterTest<LayeredBloom
* A Predicate that advances after a quantum of time.
*/
static class AdvanceOnTimeQuanta implements Predicate<LayerManager<TimestampedBloomFilter>> {
- long quanta;
+ Duration quanta;
- AdvanceOnTimeQuanta(final long quanta, final TimeUnit unit) {
- this.quanta = unit.toMillis(quanta);
+ AdvanceOnTimeQuanta(final Duration quanta) {
+ this.quanta = quanta;
}
@Override
- public boolean test(final LayerManager<TimestampedBloomFilter> lm) {
+ public boolean test(final LayerManager<TimestampedBloomFilter> layerManager) {
// can not use getTarget() as it causes recursion.
- return lm.last().timestamp + quanta < System.currentTimeMillis();
+ return layerManager.last().getTimestamp().plus(quanta).isBefore(Instant.now());
}
}
@@ -58,23 +59,22 @@ public class LayeredBloomFilterTest extends AbstractBloomFilterTest<LayeredBloom
* the list.
*/
static class CleanByTime<T extends TimestampedBloomFilter> implements Consumer<List<T>> {
- long elapsedTime;
+ Duration elapsedTime;
- CleanByTime(final long duration, final TimeUnit unit) {
- elapsedTime = unit.toMillis(duration);
+ CleanByTime(final Duration elapsedTime) {
+ this.elapsedTime = elapsedTime;
}
@Override
public void accept(final List<T> t) {
- final long min = System.currentTimeMillis() - elapsedTime;
+ final Instant min = Instant.now().minus(elapsedTime);
final Iterator<T> iter = t.iterator();
while (iter.hasNext()) {
final TimestampedBloomFilter bf = iter.next();
- if (bf.getTimestamp() >= min) {
+ if (bf.getTimestamp().isAfter(min) || bf.getTimestamp().equals(min)) {
return;
}
- dbgInstrument.add(String.format("Removing old entry: T:%s (Aged: %s) \n", bf.getTimestamp(),
- min - bf.getTimestamp()));
+ dbgInstrument.add(String.format("Removing old entry: T:%s (Aged: %s) \n", bf.getTimestamp(), Duration.between(bf.getTimestamp(), min)));
iter.remove();
}
}
@@ -96,17 +96,17 @@ public class LayeredBloomFilterTest extends AbstractBloomFilterTest<LayeredBloom
}
/**
- * A Bloomfilter implementation that tracks the creation time.
+ * A Bloom filter implementation that tracks the creation time.
*/
public static class TimestampedBloomFilter extends WrappedBloomFilter {
- final long timestamp;
+
+ private final Instant timestamp;
TimestampedBloomFilter(final BloomFilter bf) {
- super(bf);
- this.timestamp = System.currentTimeMillis();
+ this(bf, Instant.now());
}
- TimestampedBloomFilter(final BloomFilter bf, final long timestamp) {
+ TimestampedBloomFilter(final BloomFilter bf, final Instant timestamp) {
super(bf);
this.timestamp = timestamp;
}
@@ -116,7 +116,7 @@ public class LayeredBloomFilterTest extends AbstractBloomFilterTest<LayeredBloom
return new TimestampedBloomFilter(getWrapped().copy(), timestamp);
}
- public long getTimestamp() {
+ public Instant getTimestamp() {
return timestamp;
}
}
@@ -131,20 +131,17 @@ public class LayeredBloomFilterTest extends AbstractBloomFilterTest<LayeredBloom
*
* @param shape The shape of the Bloom filters.
* @param duration The length of time to keep filters in the list.
- * @param dUnit The unit of time to apply to duration.
* @param quanta The quantization factor for each filter. Individual filters
* will span at most this much time.
- * @param qUnit the unit of time to apply to quanta.
* @return LayeredBloomFilter with the above properties.
*/
- static LayeredBloomFilter<TimestampedBloomFilter> createTimedLayeredFilter(final Shape shape, final long duration, final TimeUnit dUnit, final long quanta,
- final TimeUnit qUnit) {
+ static LayeredBloomFilter<TimestampedBloomFilter> createTimedLayeredFilter(final Shape shape, final Duration duration, final Duration quanta) {
final LayerManager.Builder<TimestampedBloomFilter> builder = LayerManager.builder();
- final Consumer<Deque<TimestampedBloomFilter>> cleanup = Cleanup.removeEmptyTarget().andThen(new CleanByTime(duration, dUnit));
+ final Consumer<Deque<TimestampedBloomFilter>> cleanup = Cleanup.removeEmptyTarget().andThen(new CleanByTime(duration));
final LayerManager<TimestampedBloomFilter> layerManager = builder
.setSupplier(() -> new TimestampedBloomFilter(new SimpleBloomFilter(shape)))
.setCleanup(cleanup)
- .setExtendCheck(new AdvanceOnTimeQuanta(quanta, qUnit)
+ .setExtendCheck(new AdvanceOnTimeQuanta(quanta)
.or(LayerManager.ExtendCheck.advanceOnSaturation(shape.estimateMaxN())))
.build();
return new LayeredBloomFilter<>(shape, layerManager);
@@ -183,8 +180,8 @@ public class LayeredBloomFilterTest extends AbstractBloomFilterTest<LayeredBloom
// instrumentation to record timestamps in dbgInstrument list
private final Predicate<BloomFilter> dbg = bf -> {
final TimestampedBloomFilter tbf = (TimestampedBloomFilter) bf;
- final long ts = System.currentTimeMillis();
- dbgInstrument.add(String.format("T:%s (Elapsed:%s)- EstN:%s (Card:%s)\n", tbf.timestamp, ts - tbf.timestamp,
+ final Instant ts = Instant.now();
+ dbgInstrument.add(String.format("T:%s (Elapsed:%s)- EstN:%s (Card:%s)\n", tbf.timestamp, Duration.between(tbf.timestamp, ts),
tbf.estimateN(), tbf.cardinality()));
return true;
};
@@ -280,13 +277,12 @@ public class LayeredBloomFilterTest extends AbstractBloomFilterTest<LayeredBloom
// purposes.
// list of timestamps that are expected to be expired.
- final List<Long> lst = new ArrayList<>();
+ final List<Instant> lst = new ArrayList<>();
final Shape shape = Shape.fromNM(4, 64);
// create a filter that removes filters that are 4 seconds old
// and quantises time to 1 second intervals.
- final LayeredBloomFilter<TimestampedBloomFilter> underTest = createTimedLayeredFilter(shape, 600, TimeUnit.MILLISECONDS, 150,
- TimeUnit.MILLISECONDS);
+ final LayeredBloomFilter<TimestampedBloomFilter> underTest = createTimedLayeredFilter(shape, Duration.ofMillis(600), Duration.ofMillis(150));
for (int i = 0; i < 10; i++) {
underTest.merge(TestingHashers.randomHasher());
(commons-collections) 04/18: Better parameter names
Posted by gg...@apache.org.
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 7023b20fbe3be4c795e855078fd92ef6ad2bd434
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 16:31:49 2024 -0400
Better parameter names
---
.../java/org/apache/commons/collections4/bidimap/TreeBidiMap.java | 4 ++--
.../collections4/iterators/AbstractMapIteratorDecorator.java | 4 ++--
.../iterators/AbstractOrderedMapIteratorDecorator.java | 4 ++--
.../commons/collections4/keyvalue/AbstractMapEntryDecorator.java | 4 ++--
.../org/apache/commons/collections4/list/AbstractLinkedList.java | 4 ++--
.../org/apache/commons/collections4/map/AbstractReferenceMap.java | 8 ++++----
.../java/org/apache/commons/collections4/map/StaticBucketMap.java | 8 ++++----
.../org/apache/commons/collections4/map/UnmodifiableEntrySet.java | 2 +-
8 files changed, 19 insertions(+), 19 deletions(-)
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 13a3c2aa1..1f5c66acf 100644
--- a/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
+++ b/src/main/java/org/apache/commons/collections4/bidimap/TreeBidiMap.java
@@ -515,7 +515,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>>
}
@Override
- public K setValue(final K obj) {
+ public K setValue(final K value) {
throw new UnsupportedOperationException();
}
}
@@ -860,7 +860,7 @@ public class TreeBidiMap<K extends Comparable<K>, V extends Comparable<V>>
}
@Override
- public V setValue(final V obj) {
+ public V setValue(final V value) {
throw new UnsupportedOperationException();
}
}
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java
index 995c54d86..8ed627a53 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractMapIteratorDecorator.java
@@ -85,8 +85,8 @@ public class AbstractMapIteratorDecorator<K, V> implements MapIterator<K, V> {
/** {@inheritDoc} */
@Override
- public V setValue(final V obj) {
- return iterator.setValue(obj);
+ public V setValue(final V value) {
+ return iterator.setValue(value);
}
}
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java
index 2f1210df3..cbeaab2c6 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractOrderedMapIteratorDecorator.java
@@ -97,8 +97,8 @@ public class AbstractOrderedMapIteratorDecorator<K, V> implements OrderedMapIter
/** {@inheritDoc} */
@Override
- public V setValue(final V obj) {
- return iterator.setValue(obj);
+ public V setValue(final V value) {
+ return iterator.setValue(value);
}
}
diff --git a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java
index 442b6eeb3..08bd0d24e 100644
--- a/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java
+++ b/src/main/java/org/apache/commons/collections4/keyvalue/AbstractMapEntryDecorator.java
@@ -77,8 +77,8 @@ public abstract class AbstractMapEntryDecorator<K, V> implements Map.Entry<K, V>
}
@Override
- public V setValue(final V object) {
- return entry.setValue(object);
+ public V setValue(final V value) {
+ return entry.setValue(value);
}
@Override
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 eef3e27b4..0a941b6e4 100644
--- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
@@ -213,9 +213,9 @@ public abstract class AbstractLinkedList<E> implements List<E> {
}
@Override
- public void set(final E obj) {
+ public void set(final E value) {
checkModCount();
- getLastNodeReturned().setValue(obj);
+ getLastNodeReturned().setValue(value);
}
}
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 0f926a474..7ff279752 100644
--- a/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/AbstractReferenceMap.java
@@ -329,17 +329,17 @@ public abstract class AbstractReferenceMap<K, V> extends AbstractHashedMap<K, V>
/**
* Sets the value of the entry.
*
- * @param obj the object to store
+ * @param value the object to store
* @return the previous value
*/
@Override
@SuppressWarnings("unchecked")
- public V setValue(final V obj) {
+ public V setValue(final V value) {
final V old = getValue();
if (parent.valueType != ReferenceStrength.HARD) {
- ((Reference<V>) value).clear();
+ ((Reference<V>) this.value).clear();
}
- value = toReference(parent.valueType, obj, hashCode);
+ this.value = toReference(parent.valueType, value, hashCode);
return old;
}
diff --git a/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java b/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java
index 2abd65ab1..861141280 100644
--- a/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/StaticBucketMap.java
@@ -304,10 +304,10 @@ public final class StaticBucketMap<K, V> extends AbstractIterableMap<K, V> {
}
@Override
- public V setValue(final V obj) {
- final V retVal = value;
- value = obj;
- return retVal;
+ public V setValue(final V value) {
+ final V old = this.value;
+ this.value = value;
+ return old;
}
}
diff --git a/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java b/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
index 050536117..9a4674c82 100644
--- a/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
+++ b/src/main/java/org/apache/commons/collections4/map/UnmodifiableEntrySet.java
@@ -52,7 +52,7 @@ public final class UnmodifiableEntrySet<K, V>
}
@Override
- public V setValue(final V obj) {
+ public V setValue(final V value) {
throw new UnsupportedOperationException();
}
}
(commons-collections) 15/18: Javadoc
Posted by gg...@apache.org.
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 7bab3d26f2e54bcc51702647f2e50124feb7a5e5
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 25 18:36:47 2024 -0400
Javadoc
---
.../collections4/list/AbstractLinkedList.java | 49 ++++++++++++++++++++--
.../collections4/map/AbstractHashedMap.java | 18 ++++++++
2 files changed, 63 insertions(+), 4 deletions(-)
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 68353e82b..b6b4a99ee 100644
--- a/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
+++ b/src/main/java/org/apache/commons/collections4/list/AbstractLinkedList.java
@@ -293,6 +293,9 @@ public abstract class AbstractLinkedList<E> implements List<E> {
return true;
}
+ /**
+ * Throws a {@link ConcurrentModificationException} if this instance fails its concurrency check.
+ */
protected void checkModCount() {
if (parent.modCount != expectedModCount) {
throw new ConcurrentModificationException();
@@ -329,6 +332,12 @@ public abstract class AbstractLinkedList<E> implements List<E> {
return parent.createSubListListIterator(this, index);
}
+ /**
+ * Throws an {@link IndexOutOfBoundsException} if the given indices are out of bounds.
+ *
+ * @param index lower index.
+ * @param beyond upper index.
+ */
protected void rangeCheck(final int index, final int beyond) {
if (index < 0 || index >= beyond) {
throw new IndexOutOfBoundsException("Index '" + index + "' out of bounds for size '" + size + "'");
@@ -583,13 +592,25 @@ public abstract class AbstractLinkedList<E> implements List<E> {
return true;
}
- public boolean addFirst(final E o) {
- addNodeAfter(header, o);
+ /**
+ * Adds an element at the beginning.
+ *
+ * @param e the element to beginning.
+ * @return true.
+ */
+ public boolean addFirst(final E e) {
+ addNodeAfter(header, e);
return true;
}
- public boolean addLast(final E o) {
- addNodeBefore(header, o);
+ /**
+ * Adds an element at the end.
+ *
+ * @param e the element to add.
+ * @return true.
+ */
+ public boolean addLast(final E e) {
+ addNodeBefore(header, e);
return true;
}
@@ -771,6 +792,11 @@ public abstract class AbstractLinkedList<E> implements List<E> {
return node.getValue();
}
+ /**
+ * Gets the first element.
+ *
+ * @return the first element.
+ */
public E getFirst() {
final Node<E> node = header.next;
if (node == header) {
@@ -779,6 +805,11 @@ public abstract class AbstractLinkedList<E> implements List<E> {
return node.getValue();
}
+ /**
+ * Gets the last element.
+ *
+ * @return the last element.
+ */
public E getLast() {
final Node<E> node = header.previous;
if (node == header) {
@@ -958,6 +989,11 @@ public abstract class AbstractLinkedList<E> implements List<E> {
modCount++;
}
+ /**
+ * Removes the first element.
+ *
+ * @return The value removed.
+ */
public E removeFirst() {
final Node<E> node = header.next;
if (node == header) {
@@ -968,6 +1004,11 @@ public abstract class AbstractLinkedList<E> implements List<E> {
return oldValue;
}
+ /**
+ * Removes the last element.
+ *
+ * @return The value removed.
+ */
public E removeLast() {
final Node<E> node = header.previous;
if (node == header) {
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 fcc86d401..a47fe87b7 100644
--- a/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/AbstractHashedMap.java
@@ -272,14 +272,29 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
this.expectedModCount = parent.modCount;
}
+ /**
+ * Gets the current entry.
+ *
+ * @return the current entry.
+ */
protected HashEntry<K, V> currentEntry() {
return last;
}
+ /**
+ * Tests whether there is a next entry.
+ *
+ * @return whether there is a next entry.
+ */
public boolean hasNext() {
return next != null;
}
+ /**
+ * Gets the next entry.
+ *
+ * @return the next entry.
+ */
protected HashEntry<K, V> nextEntry() {
if (parent.modCount != expectedModCount) {
throw new ConcurrentModificationException();
@@ -300,6 +315,9 @@ public class AbstractHashedMap<K, V> extends AbstractMap<K, V> implements Iterab
return newCurrent;
}
+ /**
+ * Removes the current element.
+ */
public void remove() {
if (last == null) {
throw new IllegalStateException(REMOVE_INVALID);