summaryrefslogtreecommitdiffstats
path: root/common-app-api/src/main/java/org/openecomp/sdc/common/datastructure/CapList.java
blob: d202715faec6b136df490d5703c9447d54f9e894 (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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.sdc.common.datastructure;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.ListIterator;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;

/**
 * Thread Safe List with a cap for Max elements.<br>
 * If an element would be inserted to the list and it is full, the oldest
 * element will be taken out.
 * 
 * @author mshitrit
 *
 * @param <T>
 */
public class CapList<T> implements List<T> {
	private static final int DEFAULT_CAP = 1000;
	private int cap;
	private ReadWriteLock readWriteLock;
	private List<T> innerList;

	public CapList() {
		this(DEFAULT_CAP);
	}

	public CapList(int cap) {
		if (cap < 1) {
			throw new RuntimeException("List Cap Must Be Positive");
		}
		this.cap = cap;
		innerList = new ArrayList<>();
		readWriteLock = new ReentrantReadWriteLock();
	}

	@Override
	public boolean add(T e) {
		try {
			readWriteLock.writeLock().lock();
			boolean result = innerList.add(e);
			removeExtras();
			return result;

		} finally {
			readWriteLock.writeLock().unlock();
		}

	}

	private void removeExtras() {
		while (innerList.size() > cap) {
			innerList.remove(0);
		}
	}

	@Override
	public void add(int index, T element) {
		try {
			readWriteLock.writeLock().lock();
			innerList.add(index, element);
		} finally {
			readWriteLock.writeLock().unlock();
		}

	}

	@Override
	public boolean addAll(Collection<? extends T> c) {
		try {
			readWriteLock.writeLock().lock();
			boolean result = innerList.addAll(c);
			removeExtras();
			return result;
		} finally {
			readWriteLock.writeLock().unlock();
		}
	}

	@Override
	public boolean addAll(int index, Collection<? extends T> c) {
		try {
			readWriteLock.writeLock().lock();
			boolean result = innerList.addAll(index, c);
			removeExtras();
			return result;
		} finally {
			readWriteLock.writeLock().unlock();
		}
	}

	@Override
	public void clear() {
		try {
			readWriteLock.writeLock().lock();
			innerList.clear();
		} finally {
			readWriteLock.writeLock().unlock();
		}

	}

	@Override
	public boolean contains(Object o) {
		try {
			readWriteLock.readLock().lock();
			return innerList.contains(o);

		} finally {
			readWriteLock.readLock().unlock();
		}

	}

	@Override
	public boolean containsAll(Collection<?> c) {
		try {
			readWriteLock.readLock().lock();
			return innerList.containsAll(c);

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public T get(int index) {
		try {
			readWriteLock.readLock().lock();
			return innerList.get(index);

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public int indexOf(Object o) {
		try {
			readWriteLock.readLock().lock();
			return innerList.indexOf(o);

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public boolean isEmpty() {
		try {
			readWriteLock.readLock().lock();
			return innerList.isEmpty();

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public Iterator<T> iterator() {
		try {
			readWriteLock.readLock().lock();
			return innerList.iterator();

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public int lastIndexOf(Object o) {
		try {
			readWriteLock.readLock().lock();
			return innerList.lastIndexOf(o);

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public ListIterator<T> listIterator() {
		try {
			readWriteLock.readLock().lock();
			return innerList.listIterator();

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public ListIterator<T> listIterator(int index) {
		try {
			readWriteLock.readLock().lock();
			return innerList.listIterator(index);

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public boolean remove(Object o) {
		try {
			readWriteLock.writeLock().lock();
			return innerList.remove(o);

		} finally {
			readWriteLock.writeLock().unlock();
		}
	}

	@Override
	public T remove(int index) {
		try {
			readWriteLock.writeLock().lock();
			return innerList.remove(index);

		} finally {
			readWriteLock.writeLock().unlock();
		}
	}

	@Override
	public boolean removeAll(Collection<?> c) {
		try {
			readWriteLock.writeLock().lock();
			return innerList.removeAll(c);

		} finally {
			readWriteLock.writeLock().unlock();
		}
	}

	@Override
	public boolean retainAll(Collection<?> c) {
		try {
			readWriteLock.writeLock().lock();
			return innerList.retainAll(c);

		} finally {
			readWriteLock.writeLock().unlock();
		}
	}

	@Override
	public T set(int index, T element) {
		try {
			readWriteLock.writeLock().lock();
			return innerList.set(index, element);

		} finally {
			readWriteLock.writeLock().unlock();
		}
	}

	@Override
	public int size() {
		try {
			readWriteLock.readLock().lock();
			return innerList.size();

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public List<T> subList(int fromIndex, int toIndex) {
		try {
			readWriteLock.readLock().lock();
			return innerList.subList(fromIndex, toIndex);

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public Object[] toArray() {
		try {
			readWriteLock.readLock().lock();
			return innerList.toArray();

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

	@Override
	public <T> T[] toArray(T[] a) {
		try {
			readWriteLock.readLock().lock();
			return innerList.toArray(a);

		} finally {
			readWriteLock.readLock().unlock();
		}
	}

}