summaryrefslogtreecommitdiff
path: root/src/main/java/sevenUnitsGUI/DelegateListModel.java
blob: da4f978e1c26c4ce30df1f0ff287a3b85ad08543 (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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
/**
 * Copyright (C) 2018, 2022, 2024 Adrien Hopkins
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
package sevenUnitsGUI;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;

import javax.swing.AbstractListModel;

/**
 * A list model that delegates to a list.
 * <p>
 * It is recommended to use the delegate methods in DelegateListModel instead of
 * the delegated list's methods because the delegate methods handle updating the
 * list.
 * </p>
 *
 * @author Adrien Hopkins
 * @since 2019-01-14
 * @since v0.1.0
 */
final class DelegateListModel<E> extends AbstractListModel<E>
		implements List<E> {
	/**
	 * @since 2019-01-14
	 * @since v0.1.0
	 */
	private static final long serialVersionUID = 8985494428224810045L;

	/**
	 * The list that this model is a delegate to.
	 *
	 * @since 2019-01-14
	 * @since v0.1.0
	 */
	private final List<E> delegate;

	/**
	 * Creates an empty {@code DelegateListModel}.
	 *
	 * @since 2019-04-13
	 * @since v0.2.0
	 */
	public DelegateListModel() {
		this(new ArrayList<>());
	}

	/**
	 * Creates the {@code DelegateListModel}.
	 *
	 * @param delegate list to delegate
	 * @since 2019-01-14
	 * @since v0.1.0
	 */
	public DelegateListModel(final List<E> delegate) {
		this.delegate = delegate;
	}

	@Override
	public boolean add(final E element) {
		final var index = this.delegate.size();
		final var success = this.delegate.add(element);
		this.fireIntervalAdded(this, index, index);
		return success;
	}

	@Override
	public void add(final int index, final E element) {
		this.delegate.add(index, element);
		this.fireIntervalAdded(this, index, index);
	}

	@Override
	public boolean addAll(final Collection<? extends E> c) {
		var changed = false;
		for (final E e : c) {
			if (this.add(e)) {
				changed = true;
			}
		}
		return changed;
	}

	@Override
	public boolean addAll(final int index, final Collection<? extends E> c) {
		for (final E e : c) {
			this.add(index, e);
		}
		return !c.isEmpty(); // Since this is a list, it will always change if c
									// has elements.
	}

	@Override
	public void clear() {
		final var oldSize = this.delegate.size();
		this.delegate.clear();
		if (oldSize >= 1) {
			this.fireIntervalRemoved(this, 0, oldSize - 1);
		}
	}

	@Override
	public boolean contains(final Object elem) {
		return this.delegate.contains(elem);
	}

	@Override
	public boolean containsAll(final Collection<?> c) {
		for (final Object e : c) {
			if (!c.contains(e))
				return false;
		}
		return true;
	}

	@Override
	public E get(final int index) {
		return this.delegate.get(index);
	}

	@Override
	public E getElementAt(final int index) {
		return this.delegate.get(index);
	}

	@Override
	public int getSize() {
		return this.delegate.size();
	}

	@Override
	public int indexOf(final Object elem) {
		return this.delegate.indexOf(elem);
	}

	@Override
	public boolean isEmpty() {
		return this.delegate.isEmpty();
	}

	@Override
	public Iterator<E> iterator() {
		return this.delegate.iterator();
	}

	@Override
	public int lastIndexOf(final Object elem) {
		return this.delegate.lastIndexOf(elem);
	}

	@Override
	public ListIterator<E> listIterator() {
		return this.delegate.listIterator();
	}

	@Override
	public ListIterator<E> listIterator(final int index) {
		return this.delegate.listIterator(index);
	}

	@Override
	public E remove(final int index) {
		final var returnValue = this.delegate.get(index);
		this.delegate.remove(index);
		this.fireIntervalRemoved(this, index, index);
		return returnValue;
	}

	@Override
	public boolean remove(final Object o) {
		final var index = this.delegate.indexOf(o);
		final var returnValue = this.delegate.remove(o);
		this.fireIntervalRemoved(this, index, index);
		return returnValue;
	}

	@Override
	public boolean removeAll(final Collection<?> c) {
		var changed = false;
		for (final Object e : c) {
			if (this.remove(e)) {
				changed = true;
			}
		}
		return changed;
	}

	@Override
	public boolean retainAll(final Collection<?> c) {
		final var oldSize = this.size();
		final var returnValue = this.delegate.retainAll(c);
		this.fireIntervalRemoved(this, this.size(), oldSize - 1);
		return returnValue;
	}

	@Override
	public E set(final int index, final E element) {
		final var returnValue = this.delegate.get(index);
		this.delegate.set(index, element);
		this.fireContentsChanged(this, index, index);
		return returnValue;
	}

	@Override
	public int size() {
		return this.delegate.size();
	}

	@Override
	public List<E> subList(final int fromIndex, final int toIndex) {
		return this.delegate.subList(fromIndex, toIndex);
	}

	@Override
	public Object[] toArray() {
		return this.delegate.toArray();
	}

	@Override
	public <T> T[] toArray(final T[] a) {
		return this.delegate.toArray(a);
	}

	@Override
	public String toString() {
		return this.delegate.toString();
	}
}