This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-collections.git
The following commit(s) were added to refs/heads/master by this push:
new b4e7ff365 Javadoc
b4e7ff365 is described below
commit b4e7ff365c5b9db4adf829e8e5a200f12347e6f8
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Mar 23 10:29:21 2025 -0400
Javadoc
---
.../java/org/apache/commons/collections4/map/LRUMap.java | 2 +-
.../commons/collections4/trie/AbstractPatriciaTrie.java | 14 ++++++++------
.../collections4/iterators/AbstractIteratorTest.java | 6 +++---
.../collections4/iterators/AbstractListIteratorTest.java | 4 ++--
.../collections4/iterators/AbstractMapIteratorTest.java | 2 +-
5 files changed, 15 insertions(+), 13 deletions(-)
diff --git a/src/main/java/org/apache/commons/collections4/map/LRUMap.java
b/src/main/java/org/apache/commons/collections4/map/LRUMap.java
index c4758a861..2cc3400b4 100644
--- a/src/main/java/org/apache/commons/collections4/map/LRUMap.java
+++ b/src/main/java/org/apache/commons/collections4/map/LRUMap.java
@@ -360,7 +360,7 @@ public class LRUMap<K, V>
}
/**
- * Whether this LRUMap will scan until a removable entry is found when the
+ * Tests whether this LRUMap will scan until a removable entry is found
when the
* map is full.
*
* @return true if this map scans
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 55175c9e9..ccd89d5c7 100644
---
a/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
+++
b/src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java
@@ -164,12 +164,16 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
}
/**
- * Whether or not the {@link #getFromKey()} is in the range.
+ * Tests whether or not the {@link #getFromKey()} is in the range.
+ *
+ * @return whether or not the {@link #getFromKey()} is in the range.
*/
protected abstract boolean isFromInclusive();
/**
- * Whether or not the {@link #getToKey()} is in the range.
+ * Tests whether or not the {@link #getToKey()} is in the range.
+ *
+ * @return whether or not the {@link #getToKey()} is in the range.
*/
protected abstract boolean isToInclusive();
@@ -1013,9 +1017,7 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
}
/**
- * Whether the entry is storing a key.
- * Only the root can potentially be empty, all other
- * nodes must have a key.
+ * Tests 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
*/
@@ -1024,7 +1026,7 @@ public abstract class AbstractPatriciaTrie<K, V> extends
AbstractBitwiseTrie<K,
}
/**
- * Whether the left or right child is a loopback.
+ * Tests whether the left or right child is a loopback.
*
* @return Whether the left or right child is a loopback.
*/
diff --git
a/src/test/java/org/apache/commons/collections4/iterators/AbstractIteratorTest.java
b/src/test/java/org/apache/commons/collections4/iterators/AbstractIteratorTest.java
index ab435cd87..81b430047 100644
---
a/src/test/java/org/apache/commons/collections4/iterators/AbstractIteratorTest.java
+++
b/src/test/java/org/apache/commons/collections4/iterators/AbstractIteratorTest.java
@@ -61,7 +61,7 @@ public abstract class AbstractIteratorTest<E> extends
AbstractObjectTest {
public abstract Iterator<E> makeObject();
/**
- * Whether or not we are testing an iterator that can be empty.
+ * Tests whether or not we are testing an iterator that can be empty.
* Default is true.
*
* @return true if Iterator can be empty
@@ -71,7 +71,7 @@ public abstract class AbstractIteratorTest<E> extends
AbstractObjectTest {
}
/**
- * Whether or not we are testing an iterator that can contain elements.
+ * Tests whether or not we are testing an iterator that can contain
elements.
* Default is true.
*
* @return true if Iterator can be full
@@ -81,7 +81,7 @@ public abstract class AbstractIteratorTest<E> extends
AbstractObjectTest {
}
/**
- * Whether or not we are testing an iterator that supports remove().
+ * Tests whether or not we are testing an iterator that supports remove().
* Default is true.
*
* @return true if Iterator supports remove
diff --git
a/src/test/java/org/apache/commons/collections4/iterators/AbstractListIteratorTest.java
b/src/test/java/org/apache/commons/collections4/iterators/AbstractListIteratorTest.java
index 2b108e443..20dbf6cc8 100644
---
a/src/test/java/org/apache/commons/collections4/iterators/AbstractListIteratorTest.java
+++
b/src/test/java/org/apache/commons/collections4/iterators/AbstractListIteratorTest.java
@@ -66,7 +66,7 @@ public abstract class AbstractListIteratorTest<E> extends
AbstractIteratorTest<E
public abstract ListIterator<E> makeObject();
/**
- * Whether or not we are testing an iterator that supports add().
+ * Tests whether or not we are testing an iterator that supports add().
* Default is true.
*
* @return true if Iterator supports add
@@ -76,7 +76,7 @@ public abstract class AbstractListIteratorTest<E> extends
AbstractIteratorTest<E
}
/**
- * Whether or not we are testing an iterator that supports set().
+ * Tests whether or not we are testing an iterator that supports set().
* Default is true.
*
* @return true if Iterator supports set
diff --git
a/src/test/java/org/apache/commons/collections4/iterators/AbstractMapIteratorTest.java
b/src/test/java/org/apache/commons/collections4/iterators/AbstractMapIteratorTest.java
index 292ecba96..23cea5d87 100644
---
a/src/test/java/org/apache/commons/collections4/iterators/AbstractMapIteratorTest.java
+++
b/src/test/java/org/apache/commons/collections4/iterators/AbstractMapIteratorTest.java
@@ -71,7 +71,7 @@ public abstract class AbstractMapIteratorTest<K, V> extends
AbstractIteratorTest
public abstract Map<K, V> getMap();
/**
- * Whether the get operation on the map structurally modifies the map,
+ * Tests whether the get operation on the map structurally modifies the
map,
* such as with LRUMap. Default is false.
*
* @return true if the get method structurally modifies the map
