Added missing javadoc.
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/collections/trunk@1374050 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
parent
b5715ec19d
commit
340cf440b9
|
@ -34,6 +34,8 @@ public abstract class AbstractUntypedIteratorDecorator<I, O> implements Iterator
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Create a new AbstractUntypedIteratorDecorator.
|
* Create a new AbstractUntypedIteratorDecorator.
|
||||||
|
*
|
||||||
|
* @param iterator the iterator to decorate
|
||||||
*/
|
*/
|
||||||
protected AbstractUntypedIteratorDecorator(Iterator<I> iterator) {
|
protected AbstractUntypedIteratorDecorator(Iterator<I> iterator) {
|
||||||
super();
|
super();
|
||||||
|
|
|
@ -89,7 +89,8 @@ public class ListIteratorWrapper<E> implements ResettableListIterator<E> {
|
||||||
* unless the underlying <code>Iterator</code> is a <code>ListIterator</code>.
|
* unless the underlying <code>Iterator</code> is a <code>ListIterator</code>.
|
||||||
*
|
*
|
||||||
* @param obj the object to add
|
* @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 {
|
public void add(E obj) throws UnsupportedOperationException {
|
||||||
if (iterator instanceof ListIterator) {
|
if (iterator instanceof ListIterator) {
|
||||||
|
@ -225,7 +226,8 @@ public class ListIteratorWrapper<E> implements ResettableListIterator<E> {
|
||||||
* unless the underlying <code>Iterator</code> is a <code>ListIterator</code>.
|
* unless the underlying <code>Iterator</code> is a <code>ListIterator</code>.
|
||||||
*
|
*
|
||||||
* @param obj the object to set
|
* @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 {
|
public void set(E obj) throws UnsupportedOperationException {
|
||||||
if (iterator instanceof ListIterator) {
|
if (iterator instanceof ListIterator) {
|
||||||
|
|
|
@ -40,6 +40,7 @@ public final class UnmodifiableIterator<E> implements Iterator<E>, Unmodifiable
|
||||||
* If the iterator is already unmodifiable it is returned directly.
|
* If the iterator is already unmodifiable it is returned directly.
|
||||||
*
|
*
|
||||||
* @param iterator the iterator to decorate
|
* @param iterator the iterator to decorate
|
||||||
|
* @return a new unmodifiable iterator
|
||||||
* @throws IllegalArgumentException if the iterator is null
|
* @throws IllegalArgumentException if the iterator is null
|
||||||
*/
|
*/
|
||||||
public static <E> Iterator<E> unmodifiableIterator(Iterator<E> iterator) {
|
public static <E> Iterator<E> unmodifiableIterator(Iterator<E> iterator) {
|
||||||
|
|
|
@ -38,6 +38,7 @@ public final class UnmodifiableListIterator<E> implements ListIterator<E>, Unmod
|
||||||
* Decorates the specified iterator such that it cannot be modified.
|
* Decorates the specified iterator such that it cannot be modified.
|
||||||
*
|
*
|
||||||
* @param iterator the iterator to decorate
|
* @param iterator the iterator to decorate
|
||||||
|
* @return a new unmodifiable list iterator
|
||||||
* @throws IllegalArgumentException if the iterator is null
|
* @throws IllegalArgumentException if the iterator is null
|
||||||
*/
|
*/
|
||||||
public static <E> ListIterator<E> umodifiableListIterator(ListIterator<E> iterator) {
|
public static <E> ListIterator<E> umodifiableListIterator(ListIterator<E> iterator) {
|
||||||
|
|
|
@ -37,6 +37,7 @@ public final class UnmodifiableMapIterator<K, V> implements MapIterator<K, V>, U
|
||||||
* Decorates the specified iterator such that it cannot be modified.
|
* Decorates the specified iterator such that it cannot be modified.
|
||||||
*
|
*
|
||||||
* @param iterator the iterator to decorate
|
* @param iterator the iterator to decorate
|
||||||
|
* @return a new unmodifiable map iterator
|
||||||
* @throws IllegalArgumentException if the iterator is null
|
* @throws IllegalArgumentException if the iterator is null
|
||||||
*/
|
*/
|
||||||
public static <K, V> MapIterator<K, V> unmodifiableMapIterator(MapIterator<K, V> iterator) {
|
public static <K, V> MapIterator<K, V> unmodifiableMapIterator(MapIterator<K, V> iterator) {
|
||||||
|
|
|
@ -38,6 +38,7 @@ public final class UnmodifiableOrderedMapIterator<K, V> implements OrderedMapIte
|
||||||
* Decorates the specified iterator such that it cannot be modified.
|
* Decorates the specified iterator such that it cannot be modified.
|
||||||
*
|
*
|
||||||
* @param iterator the iterator to decorate
|
* @param iterator the iterator to decorate
|
||||||
|
* @return a new unmodifiable ordered map iterator
|
||||||
* @throws IllegalArgumentException if the iterator is null
|
* @throws IllegalArgumentException if the iterator is null
|
||||||
*/
|
*/
|
||||||
public static <K, V> OrderedMapIterator<K, V> unmodifiableOrderedMapIterator(OrderedMapIterator<K, V> iterator) {
|
public static <K, V> OrderedMapIterator<K, V> unmodifiableOrderedMapIterator(OrderedMapIterator<K, V> iterator) {
|
||||||
|
|
Loading…
Reference in New Issue