summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java
diff options
context:
space:
mode:
authorbjculkin <bjculkin@mix.wvu.edu>2017-03-17 19:28:59 -0400
committerbjculkin <bjculkin@mix.wvu.edu>2017-03-17 19:28:59 -0400
commit5832ef0286430d04484b70d49c73e081a80ec9c7 (patch)
tree04ab56561978c14415f71b934f7d8a3aaa1a037e /BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java
parentc8593896ba0d93c9512a71c2e70d1d503627b1b0 (diff)
Add more toString/hashCode/equals
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;