-
Notifications
You must be signed in to change notification settings - Fork 585
/
ListIterable.java
306 lines (255 loc) · 10.1 KB
/
ListIterable.java
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
/*
* Copyright (c) 2018 Goldman Sachs and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Eclipse Distribution License v. 1.0 which accompany this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*/
package org.eclipse.collections.api.list;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.ListIterator;
import java.util.concurrent.ExecutorService;
import org.eclipse.collections.api.annotation.Beta;
import org.eclipse.collections.api.block.HashingStrategy;
import org.eclipse.collections.api.block.function.Function;
import org.eclipse.collections.api.block.function.Function2;
import org.eclipse.collections.api.block.function.primitive.BooleanFunction;
import org.eclipse.collections.api.block.function.primitive.ByteFunction;
import org.eclipse.collections.api.block.function.primitive.CharFunction;
import org.eclipse.collections.api.block.function.primitive.DoubleFunction;
import org.eclipse.collections.api.block.function.primitive.FloatFunction;
import org.eclipse.collections.api.block.function.primitive.IntFunction;
import org.eclipse.collections.api.block.function.primitive.LongFunction;
import org.eclipse.collections.api.block.function.primitive.ObjectIntToObjectFunction;
import org.eclipse.collections.api.block.function.primitive.ShortFunction;
import org.eclipse.collections.api.block.predicate.Predicate;
import org.eclipse.collections.api.block.predicate.Predicate2;
import org.eclipse.collections.api.block.procedure.Procedure;
import org.eclipse.collections.api.list.primitive.BooleanList;
import org.eclipse.collections.api.list.primitive.ByteList;
import org.eclipse.collections.api.list.primitive.CharList;
import org.eclipse.collections.api.list.primitive.DoubleList;
import org.eclipse.collections.api.list.primitive.FloatList;
import org.eclipse.collections.api.list.primitive.IntList;
import org.eclipse.collections.api.list.primitive.LongList;
import org.eclipse.collections.api.list.primitive.ShortList;
import org.eclipse.collections.api.multimap.list.ListMultimap;
import org.eclipse.collections.api.ordered.ReversibleIterable;
import org.eclipse.collections.api.partition.list.PartitionList;
import org.eclipse.collections.api.tuple.Pair;
/**
* An iterable whose items are ordered and may be accessed directly by index. A reverseForEach
* internal iterator is available iterating over the indexed iterable in reverse, starting from
* the end and going to the beginning. Additionally, internal iterators are available for batching
* style iteration which is useful for parallel processing.
*/
public interface ListIterable<T>
extends ReversibleIterable<T>
{
/**
* Returns the item at the specified position in this list iterable.
*/
T get(int index);
/**
* Returns the index of the last occurrence of the specified item
* in this list, or -1 if this list does not contain the item.
*/
int lastIndexOf(Object o);
/**
* Returns the item at index 0 of the container. If the container is empty, null is returned. If null
* is a valid item of the container, then a developer will need to check to see if the container is
* empty first.
*/
@Override
T getFirst();
/**
* Returns the item at index (size() - 1) of the container. If the container is empty, null is returned. If null
* is a valid item of the container, then a developer will need to check to see if the container is
* empty first.
*/
@Override
T getLast();
/**
* @see List#listIterator()
* @since 1.0.
*/
ListIterator<T> listIterator();
/**
* @see List#listIterator(int)
* @since 1.0.
*/
ListIterator<T> listIterator(int index);
/**
* Converts the ListIterable to an immutable implementation. Returns this for immutable lists.
*
* @since 5.0
*/
ImmutableList<T> toImmutable();
@Override
ListIterable<T> tap(Procedure<? super T> procedure);
@Override
ListIterable<T> select(Predicate<? super T> predicate);
@Override
<P> ListIterable<T> selectWith(Predicate2<? super T, ? super P> predicate, P parameter);
@Override
ListIterable<T> reject(Predicate<? super T> predicate);
@Override
<P> ListIterable<T> rejectWith(Predicate2<? super T, ? super P> predicate, P parameter);
@Override
PartitionList<T> partition(Predicate<? super T> predicate);
@Override
<P> PartitionList<T> partitionWith(Predicate2<? super T, ? super P> predicate, P parameter);
@Override
<S> ListIterable<S> selectInstancesOf(Class<S> clazz);
@Override
<V> ListIterable<V> collect(Function<? super T, ? extends V> function);
/**
* @since 9.1.
*/
@Override
default <V> ListIterable<V> collectWithIndex(ObjectIntToObjectFunction<? super T, ? extends V> function)
{
int[] index = {0};
return this.collect(each -> function.valueOf(each, index[0]++));
}
@Override
BooleanList collectBoolean(BooleanFunction<? super T> booleanFunction);
@Override
ByteList collectByte(ByteFunction<? super T> byteFunction);
@Override
CharList collectChar(CharFunction<? super T> charFunction);
@Override
DoubleList collectDouble(DoubleFunction<? super T> doubleFunction);
@Override
FloatList collectFloat(FloatFunction<? super T> floatFunction);
@Override
IntList collectInt(IntFunction<? super T> intFunction);
@Override
LongList collectLong(LongFunction<? super T> longFunction);
@Override
ShortList collectShort(ShortFunction<? super T> shortFunction);
@Override
<P, V> ListIterable<V> collectWith(Function2<? super T, ? super P, ? extends V> function, P parameter);
@Override
<V> ListIterable<V> collectIf(Predicate<? super T> predicate, Function<? super T, ? extends V> function);
@Override
<V> ListIterable<V> flatCollect(Function<? super T, ? extends Iterable<V>> function);
/**
* @since 9.2
*/
@Override
default <P, V> ListIterable<V> flatCollectWith(Function2<? super T, ? super P, ? extends Iterable<V>> function, P parameter)
{
return this.flatCollect(each -> function.apply(each, parameter));
}
@Override
<V> ListMultimap<V, T> groupBy(Function<? super T, ? extends V> function);
@Override
<V> ListMultimap<V, T> groupByEach(Function<? super T, ? extends Iterable<V>> function);
/**
* Returns a new {@code ListIterable} containing the distinct elements in this list.
* <p>
* Conceptually similar to {@link #toSet()}.{@link #toList()} but retains the original order. If an element appears
* multiple times in this list, the first one will be copied into the result.
*
* @return {@code ListIterable} of distinct elements
* @since 3.0
*/
@Override
ListIterable<T> distinct();
/**
* Returns a new {@code ListIterable} containing the distinct elements in this list. Takes a HashingStrategy.
*
* @return {@code ListIterable} of distinct elements
* @since 7.0
*/
ListIterable<T> distinct(HashingStrategy<? super T> hashingStrategy);
/**
* Returns a new {@code ListIterable} containing the distinct elements in this list.
* The specified function will be used to create a HashingStrategy to unique the elements.
*
* @see ListIterable#distinct(HashingStrategy)
* @since 9.0
*/
<V> ListIterable<T> distinctBy(Function<? super T, ? extends V> function);
@Override
<S> ListIterable<Pair<T, S>> zip(Iterable<S> that);
@Override
ListIterable<Pair<T, Integer>> zipWithIndex();
@Override
ListIterable<T> take(int count);
/**
* Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not
* satisfy the Predicate.
*
* @since 3.0
*/
@Override
ListIterable<T> takeWhile(Predicate<? super T> predicate);
@Override
ListIterable<T> drop(int count);
/**
* Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does
* satisfy the Predicate.
*
* @since 3.0
*/
@Override
ListIterable<T> dropWhile(Predicate<? super T> predicate);
/**
* Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does
* satisfy the Predicate.
*
* @since 3.0
*/
@Override
PartitionList<T> partitionWhile(Predicate<? super T> predicate);
@Override
ListIterable<T> toReversed();
/**
* Returns a parallel iterable of this ListIterable.
*
* @since 6.0
*/
@Beta
ParallelListIterable<T> asParallel(ExecutorService executorService, int batchSize);
/**
* Searches for the specified object using the binary search algorithm. The list must be sorted into ascending
* order according to the specified comparator.
*
* @see Collections#binarySearch(List, Object, Comparator)
*/
default int binarySearch(T key, Comparator<? super T> comparator)
{
return Collections.binarySearch((List<? extends T>) this, key, comparator);
}
/**
* Searches for the specified object using the binary search algorithm. The elements in this list must implement
* Comparable and the list must be sorted into ascending order.
*
* @see Collections#binarySearch(List, Object)
*/
default int binarySearch(T key)
{
return Collections.binarySearch((List<? extends Comparable<? super T>>) this, key);
}
/**
* Follows the same general contract as {@link List#equals(Object)}.
*/
@Override
boolean equals(Object o);
/**
* Follows the same general contract as {@link List#hashCode()}.
*/
@Override
int hashCode();
/**
* @see List#subList(int, int)
* @since 6.0
*/
ListIterable<T> subList(int fromIndex, int toIndex);
}