Skip to content

Commit

Permalink
Javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
garydgregory committed Aug 29, 2023
1 parent 9d3c2ed commit c5c4194
Show file tree
Hide file tree
Showing 10 changed files with 52 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,10 @@ protected Iterator<Map.Entry<K, V>> createEntrySetIterator(final Iterator<Map.En

/**
* Inner class View.
*
* @param <K> the type of the keys in the map.
* @param <V> the type of the values in the map.
* @param <E> the type of the elements in the collection.
*/
protected abstract static class View<K, V, E> extends AbstractCollectionDecorator<E> {

Expand Down Expand Up @@ -432,6 +436,8 @@ public void clear() {

/**
* Inner class KeySet.
*
* @param <K> the type of elements maintained by this set
*/
protected static class KeySet<K> extends View<K, Object, K> implements Set<K> {

Expand Down Expand Up @@ -471,6 +477,8 @@ public boolean remove(final Object key) {

/**
* Inner class KeySetIterator.
*
* @param <K> the key type.
*/
protected static class KeySetIterator<K> extends AbstractIteratorDecorator<K> {

Expand Down Expand Up @@ -515,6 +523,8 @@ public void remove() {

/**
* Inner class Values.
*
* @param <V> the type of the values.
*/
protected static class Values<V> extends View<Object, V, V> implements Set<V> {

Expand Down Expand Up @@ -554,6 +564,8 @@ public boolean remove(final Object value) {

/**
* Inner class ValuesIterator.
*
* @param <V> the value type.
*/
protected static class ValuesIterator<V> extends AbstractIteratorDecorator<V> {

Expand Down Expand Up @@ -598,6 +610,9 @@ public void remove() {

/**
* Inner class EntrySet.
*
* @param <K> the type of the keys.
* @param <V> the type of the values.
*/
protected static class EntrySet<K, V> extends View<K, V, Map.Entry<K, V>> implements Set<Map.Entry<K, V>> {

Expand Down Expand Up @@ -639,6 +654,9 @@ public boolean remove(final Object obj) {

/**
* Inner class EntrySetIterator.
*
* @param <K> the type of the keys.
* @param <V> the type of the values.
*/
protected static class EntrySetIterator<K, V> extends AbstractIteratorDecorator<Map.Entry<K, V>> {

Expand Down Expand Up @@ -684,6 +702,9 @@ public void remove() {

/**
* Inner class MapEntry.
*
* @param <K> the type of the keys.
* @param <V> the type of the values.
*/
protected static class MapEntry<K, V> extends AbstractMapEntryDecorator<K, V> {

Expand Down Expand Up @@ -715,6 +736,9 @@ public V setValue(final V value) {

/**
* Inner class MapIterator.
*
* @param <K> the type of the keys.
* @param <V> the type of the values.
*/
protected static class BidiMapIterator<K, V> implements MapIterator<K, V>, ResettableIterator<K> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,9 @@ public SortedBidiMap<V, K> inverseBidiMap() {

/**
* Internal sorted map view.
*
* @param <K> the type of the keys.
* @param <V> the type of the values.
*/
protected static class ViewMap<K, V> extends AbstractSortedMapDecorator<K, V> {
/**
Expand Down Expand Up @@ -293,6 +296,9 @@ public K nextKey(final K key) {

/**
* Inner class MapIterator.
*
* @param <K> the type of the keys.
* @param <V> the type of the values.
*/
protected static class BidiOrderedMapIterator<K, V> implements OrderedMapIterator<K, V>, ResettableIterator<K> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@
* Provides basic behavior for decorating an iterator with extra functionality.
* <p>
* All methods are forwarded to the decorated iterator.
* </p>
*
* @param <E> the type of the iterator being decorated.
* @since 3.0
*/
public abstract class AbstractIteratorDecorator<E> extends AbstractUntypedIteratorDecorator<E, E> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@
* Provides basic behavior for decorating a list iterator with extra functionality.
* <p>
* All methods are forwarded to the decorated list iterator.
* </p>
*
* @param <E> the type of elements in this iterator.
* @since 3.0
*/
public class AbstractListIteratorDecorator<E> implements ListIterator<E> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,13 @@
import java.util.Objects;

/**
* Provides basic behavior for decorating an iterator with extra functionality
* without committing the generic type of the Iterator implementation.
* Provides basic behavior for decorating an iterator with extra functionality without committing the generic type of the Iterator implementation.
* <p>
* All methods are forwarded to the decorated iterator.
* </p>
*
* @param <I> the type of the iterator being decorated.
* @param <O> the type of elements returned by this iterator.
*
* @since 4.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@
* removed and {@link #size()} will return the number of remaining iterators in
* the queue.
*
* @param <E> the type of elements in this iterator.
* @since 2.1
*/
public class IteratorChain<E> implements Iterator<E> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
* NOTE: The LazyIteratorChain may contain no iterators. In this case the class will
* function as an empty iterator.
*
* @param <E> the type of elements in this iterator.
* @since 4.0
*/
public abstract class LazyIteratorChain<E> implements Iterator<E> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
* <p>
* This class implements ResettableListIterator from Commons Collections 3.2.
*
* @param <E> the type of elements in this iterator.
* @since 2.1
*/
public class ListIteratorWrapper<E> implements ResettableListIterator<E> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
* is here.
* </p>
*
* @param <E> the type of elements in this list
* @since 3.0
*/
public abstract class AbstractLinkedList<E> implements List<E> {
Expand Down Expand Up @@ -745,6 +746,8 @@ protected void setNextNode(final Node<E> next) {

/**
* A list iterator over the linked list.
*
* @param <E> the type of elements in this iterator.
*/
protected static class LinkedListIterator<E> implements ListIterator<E>, OrderedIterator<E> {

Expand Down Expand Up @@ -904,6 +907,8 @@ public void add(final E obj) {

/**
* A list iterator over the linked sub list.
*
* @param <E> the type of elements in this iterator.
*/
protected static class LinkedSubListIterator<E> extends LinkedListIterator<E> {

Expand Down Expand Up @@ -947,6 +952,8 @@ public void remove() {

/**
* The sublist implementation for AbstractLinkedList.
*
* @param <E> the type of elements in this list.
*/
protected static class LinkedSubList<E> extends AbstractList<E> {
/** The main list */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -392,6 +392,8 @@ protected ListIterator<E> createSubListListIterator(final LinkedSubList<E> subLi
/**
* An extended {@code ListIterator} that allows concurrent changes to
* the underlying list.
*
* @param <E> the type of elements in this cursor.
*/
public static class Cursor<E> extends AbstractLinkedList.LinkedListIterator<E> {
/** Is the cursor valid (not closed) */
Expand Down Expand Up @@ -562,6 +564,7 @@ public void close() {
/**
* A cursor for the sublist based on LinkedSubListIterator.
*
* @param <E> the type of elements in this cursor.
* @since 3.2
*/
protected static class SubCursor<E> extends Cursor<E> {
Expand Down

0 comments on commit c5c4194

Please sign in to comment.