summaryrefslogtreecommitdiff
path: root/src/main/java/bjc/data/NonCMEListIterator.java
blob: 6e74a24be2cbe71ee58db3f777a66b1c5d48a68b (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
package bjc.data;

import java.util.*;

/**
 * A ListIterator which is guaranteed to never throw {@link ConcurrentModificationException}.
 * 
 * The intended use case for this iterator is that you want to be able to modify
 * a list you are iterating over, and not get an immediate exception.
 * 
 * Note that using this is an agreement that you will not complain if it behaves
 * oddly in the face of you concurrently modifying the list, as this class was
 * designed with the usecase of modifying the list from the same thread, without
 * invalidating the iterators. After all, there is a reason that most iterator
 * types throw that exception.
 * 
 * However, sometimes you want to play with fire, even if you might get burnt.
 * This allows you to do so.
 * 
 * @author Ben Culkin
 *
 * @param <ElementType> The type being iterated over.
 */
public class NonCMEListIterator<ElementType> extends NonCMEIterator<ElementType> implements ListIterator<ElementType> {
	/**
	 * Create a new list iterator which won't throw {@link ConcurrentModificationException}
	 * 
	 * @param source The list to iterate over.
	 */
	public NonCMEListIterator(List<ElementType> source) {
		super(source);
	}
	
	@Override
	public boolean hasPrevious() {
		return currIndex > 0;
	}

	@Override
	public ElementType previous() {
		return source.get(--currIndex);
	}

	@Override
	public int nextIndex() {
		return currIndex + 1;
	}

	@Override
	public int previousIndex() {
		return currIndex - 1;
	}

	@Override
	public void remove() {
		source.remove(currIndex);
	}

	@Override
	public void set(ElementType element) {
		source.set(currIndex, element);
	}

	@Override
	public void add(ElementType element) {
		source.add(currIndex, element);
	}
}