Author: tn
Date: Thu Aug 16 20:55:42 2012
New Revision: 1374050
URL: http://svn.apache.org/viewvc?rev=1374050&view=rev
Log:
Added missing javadoc.
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractUntypedIteratorDecorator.java
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ListIteratorWrapper.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
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractUntypedIteratorDecorator.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractUntypedIteratorDecorator.java?rev=1374050&r1=1374049&r2=1374050&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractUntypedIteratorDecorator.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/AbstractUntypedIteratorDecorator.java
Thu Aug 16 20:55:42 2012
@@ -34,6 +34,8 @@ public abstract class AbstractUntypedIte
/**
* Create a new AbstractUntypedIteratorDecorator.
+ *
+ * @param iterator the iterator to decorate
*/
protected AbstractUntypedIteratorDecorator(Iterator<I> iterator) {
super();
Modified:
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ListIteratorWrapper.java
URL:
http://svn.apache.org/viewvc/commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ListIteratorWrapper.java?rev=1374050&r1=1374049&r2=1374050&view=diff
==============================================================================
---
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ListIteratorWrapper.java
(original)
+++
commons/proper/collections/trunk/src/main/java/org/apache/commons/collections/iterators/ListIteratorWrapper.java
Thu Aug 16 20:55:42 2012
@@ -89,7 +89,8 @@ public class ListIteratorWrapper<E> impl
* unless the underlying <code>Iterator</code> is a
<code>ListIterator</code>.
*
* @param obj the object to add
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException if the underlying iterator is not
of
+ * type {@link ListIterator}
*/
public void add(E obj) throws UnsupportedOperationException {
if (iterator instanceof ListIterator) {
@@ -225,7 +226,8 @@ public class ListIteratorWrapper<E> impl
* unless the underlying <code>Iterator</code> is a
<code>ListIterator</code>.
*
* @param obj the object to set
- * @throws UnsupportedOperationException
+ * @throws UnsupportedOperationException if the underlying iterator is not
of
+ * type {@link ListIterator}
*/
public void set(E obj) throws UnsupportedOperationException {
if (iterator instanceof ListIterator) {
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=1374050&r1=1374049&r2=1374050&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
Thu Aug 16 20:55:42 2012
@@ -40,6 +40,7 @@ public final class UnmodifiableIterator<
* If the iterator is already unmodifiable it is returned directly.
*
* @param iterator the iterator to decorate
+ * @return a new unmodifiable iterator
* @throws IllegalArgumentException if the iterator is null
*/
public static <E> Iterator<E> unmodifiableIterator(Iterator<E> iterator) {
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=1374050&r1=1374049&r2=1374050&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
Thu Aug 16 20:55:42 2012
@@ -38,6 +38,7 @@ public final class UnmodifiableListItera
* Decorates the specified iterator such that it cannot be modified.
*
* @param iterator the iterator to decorate
+ * @return a new unmodifiable list iterator
* @throws IllegalArgumentException if the iterator is null
*/
public static <E> ListIterator<E> umodifiableListIterator(ListIterator<E>
iterator) {
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=1374050&r1=1374049&r2=1374050&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
Thu Aug 16 20:55:42 2012
@@ -37,6 +37,7 @@ public final class UnmodifiableMapIterat
* Decorates the specified iterator such that it cannot be modified.
*
* @param iterator the iterator to decorate
+ * @return a new unmodifiable map iterator
* @throws IllegalArgumentException if the iterator is null
*/
public static <K, V> MapIterator<K, V>
unmodifiableMapIterator(MapIterator<K, V> iterator) {
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=1374050&r1=1374049&r2=1374050&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
Thu Aug 16 20:55:42 2012
@@ -38,6 +38,7 @@ public final class UnmodifiableOrderedMa
* Decorates the specified iterator such that it cannot be modified.
*
* @param iterator the iterator to decorate
+ * @return a new unmodifiable ordered map iterator
* @throws IllegalArgumentException if the iterator is null
*/
public static <K, V> OrderedMapIterator<K, V>
unmodifiableOrderedMapIterator(OrderedMapIterator<K, V> iterator) {
