summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/data/SingleIterator.java
blob: 561cd0b26d67d18f5c122dbcfa251a138c942a5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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> {
	/* The item being held. */
	private final T itm;
	/* Whether we've yielded the item yet. */
	private boolean yielded;

	/**
	 * Create a iterator that yields a single item.
	 *
	 * @param item
	 *        The item to yield.
	 */
	public SingleIterator(final T item) {
		itm = item;

		yielded = false;
	}

	@Override
	public boolean hasNext() {
		return !yielded;
	}

	@Override
	public T next() {
		yielded = true;

		return itm;
	}
}