From 5832ef0286430d04484b70d49c73e081a80ec9c7 Mon Sep 17 00:00:00 2001
From: bjculkin <bjculkin@mix.wvu.edu>
Date: Fri, 17 Mar 2017 19:28:59 -0400
Subject: Add more toString/hashCode/equals

---
 .../src/main/java/bjc/utils/data/SingleIterator.java       | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'BJC-Utils2/src/main/java/bjc/utils/data/SingleIterator.java')

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;
 
-- 
cgit v1.2.3