Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Jun 24, 2024
1 parent 38963b1 commit a2dac49
Show file tree
Hide file tree
Showing 7 changed files with 42 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,16 @@
* the {@code target} filter.</li>
* </ol>
*
*
* @param <T> the {@link BloomFilter} type.
* @since 4.5.0
*/
public class LayerManager<T extends BloomFilter> implements BloomFilterExtractor {

/**
* Builder to create Layer Manager
* Builder to create Layer Manager.
*
* @param <T> the {@link BloomFilter} type.
*/
public static class Builder<T extends BloomFilter> {
private Predicate<LayerManager<T>> extendCheck;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,9 @@ public void remove() {
* <p>
* From Commons Collections 3.1, all access to the {@code value} property
* is via the methods on this class.
* </p>
*
* @param <E> The node value type.
*/
protected static class Node<E> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,9 @@ public abstract class AbstractLinkedMap<K, V> extends AbstractHashedMap<K, V> im

/**
* EntrySet iterator.
*
* @param <K> the key type.
* @param <V> the value type.
*/
protected static class EntrySetIterator<K, V> extends LinkIterator<K, V> implements
OrderedIterator<Map.Entry<K, V>>, ResettableIterator<Map.Entry<K, V>> {
Expand All @@ -91,6 +94,8 @@ public Map.Entry<K, V> previous() {

/**
* KeySet iterator.
*
* @param <K> the key type.
*/
protected static class KeySetIterator<K> extends LinkIterator<K, Object> implements
OrderedIterator<K>, ResettableIterator<K> {
Expand Down Expand Up @@ -118,6 +123,10 @@ public K previous() {
* then you will not be able to access the protected fields.
* The {@code entryXxx()} methods on {@code AbstractLinkedMap} exist
* to provide the necessary access.
* </p>
*
* @param <K> the key type.
* @param <V> the value type.
*/
protected static class LinkEntry<K, V> extends HashEntry<K, V> {
/** The entry before this one in the order */
Expand All @@ -140,6 +149,9 @@ protected LinkEntry(final HashEntry<K, V> next, final int hashCode, final Object

/**
* Base Iterator that iterates in link order.
*
* @param <K> the key type.
* @param <V> the value type.
*/
protected abstract static class LinkIterator<K, V> {

Expand Down Expand Up @@ -223,6 +235,9 @@ public String toString() {

/**
* MapIterator implementation.
*
* @param <K> the key type.
* @param <V> the value type.
*/
protected static class LinkMapIterator<K, V> extends LinkIterator<K, V> implements
OrderedMapIterator<K, V>, ResettableIterator<K> {
Expand Down Expand Up @@ -271,6 +286,8 @@ public V setValue(final V value) {

/**
* Values iterator.
*
* @param <V> the value type.
*/
protected static class ValuesIterator<V> extends LinkIterator<Object, V> implements
OrderedIterator<V>, ResettableIterator<V> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -972,7 +972,10 @@ public void set(final E item) {
}

/**
* A {@link org.apache.commons.collections4.Trie} is a set of {@link TrieEntry} nodes.
* A {@link org.apache.commons.collections4.Trie} is a set of {@link TrieEntry} nodes.
*
* @param <K> the key type.
* @param <V> the value type.
*/
protected static class TrieEntry<K, V> extends BasicEntry<K, V> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@

/**
* Abstract test class for {@link IterableMap} methods and contracts.
*
* @param <K> the key type.
* @param <V> the value type.
*/
public abstract class AbstractIterableMapTest<K, V> extends AbstractMapTest<K, V> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,9 @@
* If your {@link Map} fails one of these tests by design, you may still use this base set of cases. Simply override the test case (method) your map fails
* and/or the methods that define the assumptions used by the test cases. For example, if your map does not allow duplicate values, override
* {@link #isAllowDuplicateValues()} and have it return {@code false}
*
* @param <K> the key type.
* @param <V> the value type.
*/
public abstract class AbstractMapTest<K, V> extends AbstractObjectTest {

Expand Down Expand Up @@ -489,6 +492,9 @@ public void verify() {

/**
* Creates a new Map Entry that is independent of the first and the map.
*
* @param <K> the key type.
* @param <V> the value type.
*/
public static <K, V> Map.Entry<K, V> cloneMapEntry(final Map.Entry<K, V> entry) {
final HashMap<K, V> map = new HashMap<>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,10 @@ public class IdentityMap<K, V>
extends AbstractHashedMap<K, V> implements Serializable, Cloneable {

/**
* HashEntry
* HashEntry.
*
* @param <K> the key type.
* @param <V> the value type.
*/
protected static class IdentityEntry<K, V> extends HashEntry<K, V> {

Expand Down

0 comments on commit a2dac49

Please sign in to comment.