Javadoc

Author: garydgregory

src/main/java/org/apache/commons/collections4/map/LRUMap.java

@@ -360,7 +360,7 @@ public boolean isFull() {
     }
 
     /**
-     * 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

src/main/java/org/apache/commons/collections4/trie/AbstractPatriciaTrie.java

@@ -164,12 +164,16 @@ protected boolean inToRange(final K key, final boolean forceInclusive) {
         }
 
         /**
-         * 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 TrieEntry(final K key, final V value, final int bitIndex) {
         }
 
         /**
-         * 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 boolean isEmpty() {
         }
 
         /**
-         * 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.
          */

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 boolean supportsEmptyIterator() {
     }
 
     /**
-     * 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 boolean supportsFullIterator() {
     }
 
     /**
-     * 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

src/test/java/org/apache/commons/collections4/iterators/AbstractListIteratorTest.java

@@ -66,7 +66,7 @@ public E addSetValue() {
     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 boolean supportsAdd() {
     }
 
     /**
-     * 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

src/test/java/org/apache/commons/collections4/iterators/AbstractMapIteratorTest.java

@@ -71,7 +71,7 @@ public V[] addSetValues() {
     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