summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/data/CircularIterator.java
blob: 9af4d8740f3ab567f0736d37a4d7d4341b8a72dd (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
package bjc.utils.data;

import java.util.Iterator;

/**
 * An iterator that repeats elements from a provided iterable.
 *
 * @author EVE
 *
 * @param <E>
 *                The type of the iterable.
 */
public class CircularIterator<E> implements Iterator<E> {
	/* The iterable, and our current iterator into it. */
	private Iterable<E> source;
	private Iterator<E> curr;

	/* Our current element. */
	private E curElm;

	/*
	 * Should we actually get new iterators, or just repeat the last
	 * element?
	 */
	private boolean doCircle;

	/**
	 * Create a new circular iterator.
	 *
	 * @param src
	 *                The iterable to iterate from.
	 *
	 * @param circ
	 *                Should we actually do circular iteration, or just
	 *                repeat the terminal element?
	 */
	public CircularIterator(final Iterable<E> src, final boolean circ) {
		source = src;
		curr = source.iterator();

		doCircle = circ;
	}

	/**
	 * Create a new circular iterator that does actual circular iteration.
	 *
	 * @param src
	 *                The iterable to iterate from.
	 */
	public CircularIterator(final Iterable<E> src) {
		this(src, true);
	}

	@Override
	public boolean hasNext() {
		/* We always have something. */
		return true;
	}

	@Override
	public E next() {
		if (!curr.hasNext()) {
			if (!doCircle) {
				return curElm;
			}
			
			curr = source.iterator();
		}

		curElm = curr.next();

		return curElm;
	}

	@Override
	public void remove() {
		curr.remove();
	}
}