summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java
diff options
context:
space:
mode:
Diffstat (limited to 'BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java')
-rw-r--r--BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java14
1 files changed, 14 insertions, 0 deletions
diff --git a/BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java b/BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java
index 4d79b92..0ddb324 100644
--- a/BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java
+++ b/BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java
@@ -2,11 +2,25 @@ package bjc.utils.data;
import java.util.Iterator;
+/**
+ * An iterator that will only ever yield one item.
+ *
+ * @author EVE
+ *
+ * @param <T>
+ * The type of the item.
+ */
public class SingleIterator<T> implements Iterator<T> {
private T itm;
private boolean yielded;
+ /**
+ * Create a iterator that yields a single item.
+ *
+ * @param item
+ * The item to yield.
+ */
public SingleIterator(T item) {
itm = item;