diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 5a9c8bb1c7..99d06af74e 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -27,6 +27,7 @@
Complete bloom filter documentation #507.
Package private AbstractEmptyIterator implements ResettableIterator so subclasses don't.
Deprecate AbstractEmptyIterator.add(E) without replacement.
+ Add missing Javadocs.
diff --git a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java
index db1d4c676d..6d8de95866 100644
--- a/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java
+++ b/src/main/java/org/apache/commons/collections4/iterators/AbstractEmptyIterator.java
@@ -35,41 +35,79 @@ protected AbstractEmptyIterator() {
/**
* Always throws UnsupportedOperationException.
- * @param ignore ignore.
- * @throws UnsupportedOperationException
+ *
+ * @param ignored ignore.
+ * @throws UnsupportedOperationException Always thrown.
* @deprecated Will be removed in 5.0 without replacement.
*/
@Deprecated
- public void add(final E ignore) {
+ public void add(final E ignored) {
throw new UnsupportedOperationException("add() not supported for empty Iterator");
}
+ /**
+ * Always returns false, this iterator contains no elements.
+ *
+ * @return Always false.
+ */
@Override
public boolean hasNext() {
return false;
}
+ /**
+ * Always returns false, this iterator contains no elements.
+ *
+ * @return Always false.
+ */
public boolean hasPrevious() {
return false;
}
+ /**
+ * Always throws IllegalStateException, this iterator contains no elements.
+ *
+ * @return Always throws IllegalStateException.
+ * @throws IllegalStateException Always thrown.
+ */
@Override
public E next() {
throw new NoSuchElementException("Iterator contains no elements");
}
+ /**
+ * Always returns 0, this iterator contains no elements.
+ *
+ * @return Always returns 0.
+ */
public int nextIndex() {
return 0;
}
+ /**
+ * Always throws IllegalStateException, this iterator contains no elements.
+ *
+ * @return Always throws IllegalStateException.
+ * @throws IllegalStateException Always thrown.
+ */
public E previous() {
throw new NoSuchElementException("Iterator contains no elements");
}
+ /**
+ * Always returns -1, this iterator contains no elements.
+ *
+ * @return Always returns -1.
+ */
public int previousIndex() {
return -1;
}
+ /**
+ * Always throws IllegalStateException, this iterator contains no elements.
+ *
+ * @throws IllegalStateException Always thrown.
+ */
@Override
public void remove() {
throw new IllegalStateException("Iterator contains no elements");
@@ -80,7 +118,13 @@ public void reset() {
// do nothing
}
- public void set(final E obj) {
+ /**
+ * Always throws IllegalStateException, this iterator contains no elements.
+ *
+ * @param ignored ignored.
+ * @throws IllegalStateException Always thrown.
+ */
+ public void set(final E ignored) {
throw new IllegalStateException("Iterator contains no elements");
}