commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From t.@apache.org
Subject svn commit: r1382171 - in /commons/proper/collections/trunk/src/main/java/org/apache/commons/collections: iterators/ list/
Date Fri, 07 Sep 2012 21:02:39 GMT
Author: tn
Date: Fri Sep  7 21:02:38 2012
New Revision: 1382171

URL: http://svn.apache.org/viewvc?rev=1382171&view=rev
Log:
Javadoc fixes.

Modified:
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ArrayListIterator.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java
    commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/list/AbstractLinkedList.java

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ArrayListIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ArrayListIterator.java?rev=1382171&r1=1382170&r2=1382171&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ArrayListIterator.java
(original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ArrayListIterator.java
Fri Sep  7 21:02:38 2012
@@ -172,6 +172,7 @@ public class ArrayListIterator<E> extend
      * This iterator does not support modification of its backing collection, and so will
      * always throw an {@link UnsupportedOperationException} when this method is invoked.
      *
+     * @param o  the element to add
      * @throws UnsupportedOperationException always thrown.
      * @see java.util.ListIterator#set
      */
@@ -192,6 +193,9 @@ public class ArrayListIterator<E> extend
      * not support <code>add()</code> or <code>remove()</code>, <code>set()</code>
may be
      * called as often as desired.
      *
+     * @param o  the element to set
+     * @throws IllegalStateException if {@link #next()} or {@link #previous()} has not been
called
+     * before {@link #set(Object)}
      * @see java.util.ListIterator#set
      */
     public void set(Object o) {

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java?rev=1382171&r1=1382170&r2=1382171&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java
(original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableIterator.java
Fri Sep  7 21:02:38 2012
@@ -39,6 +39,7 @@ public final class UnmodifiableIterator<
      * <p>
      * If the iterator is already unmodifiable it is returned directly.
      *
+     * @param <E>  the element type
      * @param iterator  the iterator to decorate
      * @return a new unmodifiable iterator
      * @throws IllegalArgumentException if the iterator is null

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java?rev=1382171&r1=1382170&r2=1382171&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java
(original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableListIterator.java
Fri Sep  7 21:02:38 2012
@@ -37,6 +37,7 @@ public final class UnmodifiableListItera
     /**
      * Decorates the specified iterator such that it cannot be modified.
      *
+     * @param <E>  the element type
      * @param iterator  the iterator to decorate
      * @return a new unmodifiable list iterator
      * @throws IllegalArgumentException if the iterator is null

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java?rev=1382171&r1=1382170&r2=1382171&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java
(original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableMapIterator.java
Fri Sep  7 21:02:38 2012
@@ -36,6 +36,8 @@ public final class UnmodifiableMapIterat
     /**
      * Decorates the specified iterator such that it cannot be modified.
      *
+     * @param <K>  the key type
+     * @param <V>  the value type
      * @param iterator  the iterator to decorate
      * @return a new unmodifiable map iterator
      * @throws IllegalArgumentException if the iterator is null

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java?rev=1382171&r1=1382170&r2=1382171&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java
(original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/UnmodifiableOrderedMapIterator.java
Fri Sep  7 21:02:38 2012
@@ -37,6 +37,8 @@ public final class UnmodifiableOrderedMa
     /**
      * Decorates the specified iterator such that it cannot be modified.
      *
+     * @param <K>  the key type
+     * @param <V>  the value type
      * @param iterator  the iterator to decorate
      * @return a new unmodifiable ordered map iterator
      * @throws IllegalArgumentException if the iterator is null

Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/list/AbstractLinkedList.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/list/AbstractLinkedList.java?rev=1382171&r1=1382170&r2=1382171&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/list/AbstractLinkedList.java
(original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/list/AbstractLinkedList.java
Fri Sep  7 21:02:38 2012
@@ -427,6 +427,7 @@ public abstract class AbstractLinkedList
      * Subclasses can override this to create a different class.
      *
      * @param value  value of the new node
+     * @return a new node containing the value
      */
     protected Node<E> createNode(E value) {
         return new Node<E>(value);
@@ -509,6 +510,7 @@ public abstract class AbstractLinkedList
      * @param index  the index, starting from 0
      * @param endMarkerAllowed  whether or not the end marker can be returned if
      * startIndex is set to the list's size
+     * @return the node at the given index
      * @throws IndexOutOfBoundsException if the index is less than 0; equal to
      * the size of the list and endMakerAllowed is false; or greater than the
      * size of the list
@@ -551,6 +553,7 @@ public abstract class AbstractLinkedList
      * Creates an iterator for the sublist.
      *
      * @param subList  the sublist to get an iterator for
+     * @return a new iterator on the given sublist
      */
     protected Iterator<E> createSubListIterator(LinkedSubList<E> subList) {
         return createSubListListIterator(subList, 0);
@@ -561,6 +564,7 @@ public abstract class AbstractLinkedList
      *
      * @param subList  the sublist to get an iterator for
      * @param fromIndex  the index to start from, relative to the sublist
+     * @return a new list iterator on the given sublist
      */
     protected ListIterator<E> createSubListListIterator(LinkedSubList<E> subList,
int fromIndex) {
         return new LinkedSubListIterator<E>(subList, fromIndex);
@@ -749,6 +753,7 @@ public abstract class AbstractLinkedList
          *
          * @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
          */
         protected LinkedListIterator(AbstractLinkedList<E> parent, int fromIndex) throws
IndexOutOfBoundsException {
             super();
@@ -774,9 +779,9 @@ public abstract class AbstractLinkedList
         /**
          * Gets the last node returned.
          *
-         * @throws IllegalStateException If {@link #next()} or
-         * {@link #previous()} haven't been called, or if the node has been removed
-         * with {@link #remove()} or a new node added with {@link #add(Object)}.
+         * @return the last node returned
+         * @throws IllegalStateException If {@link #next()} or {@link #previous()} haven't
been called,
+         * or if the node has been removed with {@link #remove()} or a new node added with
{@link #add(Object)}.
          */
         protected Node<E> getLastNodeReturned() throws IllegalStateException {
             if (current == null) {



Mime
View raw message