You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by tn...@apache.org on 2012/08/06 21:11:32 UTC
svn commit: r1369925 -
/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/
Author: tn
Date: Mon Aug 6 19:11:31 2012
New Revision: 1369925
URL: http://svn.apache.org/viewvc?rev=1369925&view=rev
Log:
Checkstyle fixes.
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractEmptyMapIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractIteratorDecorator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractListIteratorDecorator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractMapIteratorDecorator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractOrderedMapIteratorDecorator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/CollatingIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyListIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyMapIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedMapIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/LoopingIterator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/SingletonListIterator.java
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractEmptyMapIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractEmptyMapIterator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractEmptyMapIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractEmptyMapIterator.java Mon Aug 6 19:11:31 2012
@@ -43,5 +43,4 @@ public abstract class AbstractEmptyMapIt
throw new IllegalStateException("Iterator contains no elements");
}
-
-}
\ No newline at end of file
+}
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractIteratorDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractIteratorDecorator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractIteratorDecorator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractIteratorDecorator.java Mon Aug 6 19:11:31 2012
@@ -39,6 +39,7 @@ public abstract class AbstractIteratorDe
super(iterator);
}
+ /** {@inheritDoc} */
public E next() {
return getIterator().next();
}
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractListIteratorDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractListIteratorDecorator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractListIteratorDecorator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractListIteratorDecorator.java Mon Aug 6 19:11:31 2012
@@ -56,38 +56,48 @@ public class AbstractListIteratorDecorat
}
//-----------------------------------------------------------------------
+
+ /** {@inheritDoc} */
public boolean hasNext() {
return iterator.hasNext();
}
+ /** {@inheritDoc} */
public E next() {
return iterator.next();
}
+ /** {@inheritDoc} */
public int nextIndex() {
return iterator.nextIndex();
}
+ /** {@inheritDoc} */
public boolean hasPrevious() {
return iterator.hasPrevious();
}
+ /** {@inheritDoc} */
public E previous() {
return iterator.previous();
}
+ /** {@inheritDoc} */
public int previousIndex() {
return iterator.previousIndex();
}
+ /** {@inheritDoc} */
public void remove() {
iterator.remove();
}
+ /** {@inheritDoc} */
public void set(E obj) {
iterator.set(obj);
}
+ /** {@inheritDoc} */
public void add(E obj) {
iterator.add(obj);
}
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractMapIteratorDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractMapIteratorDecorator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractMapIteratorDecorator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractMapIteratorDecorator.java Mon Aug 6 19:11:31 2012
@@ -56,26 +56,33 @@ public class AbstractMapIteratorDecorato
}
//-----------------------------------------------------------------------
+
+ /** {@inheritDoc} */
public boolean hasNext() {
return iterator.hasNext();
}
+ /** {@inheritDoc} */
public K next() {
return iterator.next();
}
+ /** {@inheritDoc} */
public void remove() {
iterator.remove();
}
-
+
+ /** {@inheritDoc} */
public K getKey() {
return iterator.getKey();
}
+ /** {@inheritDoc} */
public V getValue() {
return iterator.getValue();
}
+ /** {@inheritDoc} */
public V setValue(V obj) {
return iterator.setValue(obj);
}
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractOrderedMapIteratorDecorator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractOrderedMapIteratorDecorator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractOrderedMapIteratorDecorator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractOrderedMapIteratorDecorator.java Mon Aug 6 19:11:31 2012
@@ -56,34 +56,43 @@ public class AbstractOrderedMapIteratorD
}
//-----------------------------------------------------------------------
+
+ /** {@inheritDoc} */
public boolean hasNext() {
return iterator.hasNext();
}
+ /** {@inheritDoc} */
public K next() {
return iterator.next();
}
+ /** {@inheritDoc} */
public boolean hasPrevious() {
return iterator.hasPrevious();
}
+ /** {@inheritDoc} */
public K previous() {
return iterator.previous();
}
+ /** {@inheritDoc} */
public void remove() {
iterator.remove();
}
+ /** {@inheritDoc} */
public K getKey() {
return iterator.getKey();
}
+ /** {@inheritDoc} */
public V getValue() {
return iterator.getValue();
}
+ /** {@inheritDoc} */
public V setValue(V obj) {
return iterator.setValue(obj);
}
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/CollatingIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/CollatingIterator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/CollatingIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/CollatingIterator.java Mon Aug 6 19:11:31 2012
@@ -113,7 +113,8 @@ public class CollatingIterator<E> implem
* @param b the second child ordered iterator
* @throws NullPointerException if either iterator is null
*/
- public CollatingIterator(final Comparator<? super E> comp, final Iterator<? extends E> a, final Iterator<? extends E> b) {
+ public CollatingIterator(final Comparator<? super E> comp, final Iterator<? extends E> a,
+ final Iterator<? extends E> b) {
this(comp, 2);
addIterator(a);
addIterator(b);
@@ -203,6 +204,8 @@ public class CollatingIterator<E> implem
/**
* Gets the {@link Comparator} by which collatation occurs.
+ *
+ * @return the {@link Comparator}
*/
public Comparator<? super E> getComparator() {
return comparator;
@@ -215,6 +218,7 @@ public class CollatingIterator<E> implem
* {@link java.lang.Comparable} interface), then use the
* {@link org.apache.commons.collections.comparators.ComparableComparator}.
*
+ * @param comp the {@link Comparator} to set
* @throws IllegalStateException if iteration has started
*/
public void setComparator(final Comparator<? super E> comp) {
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyIterator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyIterator.java Mon Aug 6 19:11:31 2012
@@ -24,7 +24,7 @@ import org.apache.commons.collections.Re
* Provides an implementation of an empty iterator.
* <p>
* This class provides an implementation of an empty iterator.
- * This class provides for binary compatability between Commons Collections
+ * This class provides for binary compatibility between Commons Collections
* 2.1.1 and 3.1 due to issues with <code>IteratorUtils</code>.
*
* @since 2.1.1 and 3.1
@@ -46,7 +46,7 @@ public class EmptyIterator<E> extends Ab
/**
* Get a typed resettable empty iterator instance.
- * @param <E>
+ * @param <E> the element type
* @return ResettableIterator<E>
*/
@SuppressWarnings("unchecked")
@@ -56,7 +56,7 @@ public class EmptyIterator<E> extends Ab
/**
* Get a typed empty iterator instance.
- * @param <E>
+ * @param <E> the element type
* @return Iterator<E>
*/
@SuppressWarnings("unchecked")
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyListIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyListIterator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyListIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyListIterator.java Mon Aug 6 19:11:31 2012
@@ -24,7 +24,7 @@ import org.apache.commons.collections.Re
* Provides an implementation of an empty list iterator.
* <p>
* This class provides an implementation of an empty list iterator. This class
- * provides for binary compatability between Commons Collections 2.1.1 and 3.1
+ * provides for binary compatibility between Commons Collections 2.1.1 and 3.1
* due to issues with <code>IteratorUtils</code>.
*
* @since 2.1.1 and 3.1
@@ -47,7 +47,7 @@ public class EmptyListIterator<E> extend
/**
* Get a typed instance of the iterator.
- * @param <E>
+ * @param <E> the element type
* @return {@link ResettableListIterator}<E>
*/
@SuppressWarnings("unchecked")
@@ -57,7 +57,7 @@ public class EmptyListIterator<E> extend
/**
* Get a typed instance of the iterator.
- * @param <E>
+ * @param <E> the element type
* @return {@link ListIterator}<E>
*/
@SuppressWarnings("unchecked")
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyMapIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyMapIterator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyMapIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyMapIterator.java Mon Aug 6 19:11:31 2012
@@ -36,8 +36,8 @@ public class EmptyMapIterator<K, V> exte
/**
* Get a typed instance of the iterator.
- * @param <K>
- * @param <V>
+ * @param <K> the key type
+ * @param <V> the value type
* @return {@link MapIterator}<K, V>
*/
@SuppressWarnings("unchecked")
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedIterator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedIterator.java Mon Aug 6 19:11:31 2012
@@ -36,7 +36,7 @@ public class EmptyOrderedIterator<E> ext
/**
* Typed instance of the iterator.
- * @param <E>
+ * @param <E> the element type
* @return OrderedIterator<E>
*/
@SuppressWarnings("unchecked")
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedMapIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedMapIterator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedMapIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/EmptyOrderedMapIterator.java Mon Aug 6 19:11:31 2012
@@ -36,8 +36,8 @@ public class EmptyOrderedMapIterator<K,
/**
* Get a typed instance of the iterator.
- * @param <K>
- * @param <V>
+ * @param <K> the key type
+ * @param <V> the value type
* @return {@link OrderedMapIterator}<K, V>
*/
@SuppressWarnings("unchecked")
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/LoopingIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/LoopingIterator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/LoopingIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/LoopingIterator.java Mon Aug 6 19:11:31 2012
@@ -76,6 +76,7 @@ public class LoopingIterator<E> implemen
* <p>
* If at the end of the collection, return the first element.
*
+ * @return the next object
* @throws NoSuchElementException if there are no elements
* at all. Use {@link #hasNext} to avoid this error.
*/
Modified: commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/SingletonListIterator.java
URL: http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/SingletonListIterator.java?rev=1369925&r1=1369924&r2=1369925&view=diff
==============================================================================
--- commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/SingletonListIterator.java (original)
+++ commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/SingletonListIterator.java Mon Aug 6 19:11:31 2012
@@ -142,6 +142,7 @@ public class SingletonListIterator<E> im
/**
* Add always throws {@link UnsupportedOperationException}.
*
+ * @param obj the object to add
* @throws UnsupportedOperationException always
*/
public void add(E obj) {