-
Notifications
You must be signed in to change notification settings - Fork 584
/
StackIterable.java
232 lines (189 loc) · 7.58 KB
/
StackIterable.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
/*
* Copyright (c) 2017 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.stack;
import java.util.List;
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.ListIterable;
import org.eclipse.collections.api.multimap.list.ListMultimap;
import org.eclipse.collections.api.ordered.OrderedIterable;
import org.eclipse.collections.api.partition.stack.PartitionStack;
import org.eclipse.collections.api.stack.primitive.BooleanStack;
import org.eclipse.collections.api.stack.primitive.ByteStack;
import org.eclipse.collections.api.stack.primitive.CharStack;
import org.eclipse.collections.api.stack.primitive.DoubleStack;
import org.eclipse.collections.api.stack.primitive.FloatStack;
import org.eclipse.collections.api.stack.primitive.IntStack;
import org.eclipse.collections.api.stack.primitive.LongStack;
import org.eclipse.collections.api.stack.primitive.ShortStack;
import org.eclipse.collections.api.tuple.Pair;
/**
* StackIterable is a last-in-first-out data structure. All iteration methods iterate from the "top" of the stack to the
* "bottom". In other words, it processes the most recently added elements first.
* <p>
* For example:
* <p>
* {@link #forEach(Procedure)} iterates over every element, starting with the most recently added
* <p>
* {@link #getFirst()} returns the most recently added element, not the element that was added first
* <p>
* {@link #toString()} follows the same rules as {@link java.util.AbstractCollection#toString()} except it processes the elements
* in the same order as {@code forEach()}.
*/
public interface StackIterable<T> extends OrderedIterable<T>
{
/**
* Returns the element at the top of the stack, without removing it from the stack.
*
* @return the top of the stack.
*/
T peek();
/**
* @return a ListIterable of the number of elements specified by the count, beginning with the top of the stack.
*/
ListIterable<T> peek(int count);
/**
* Returns the element at a specific index, without removing it from the stack.
*
* @param index the location to peek into
* @return the element at the specified index
*/
T peekAt(int index);
/**
* Should return the same value as peek().
*/
@Override
default T getFirst()
{
return this.peek();
}
/**
* Should not work as it violates the contract of a Stack.
*/
@Override
T getLast();
/**
* Follows the same rules as {@link java.util.AbstractCollection#toString()} except it processes the elements
* in the same order as {@code forEach()}.
* <pre>
* Assert.assertEquals("[3, 2, 1]", Stacks.mutable.with(1, 2, 3).toString());
* </pre>
*/
@Override
String toString();
/**
* Follows the same general contract as {@link List#equals(Object)}, but for Stacks.
*/
@Override
boolean equals(Object o);
/**
* Follows the same general contract as {@link List#hashCode()}, but for Stacks.
*/
@Override
int hashCode();
@Override
StackIterable<T> takeWhile(Predicate<? super T> predicate);
@Override
StackIterable<T> dropWhile(Predicate<? super T> predicate);
@Override
PartitionStack<T> partitionWhile(Predicate<? super T> predicate);
@Override
StackIterable<T> distinct();
/**
* Converts the stack to a MutableStack implementation.
*
* @since 2.0
*/
@Override
MutableStack<T> toStack();
@Override
StackIterable<T> tap(Procedure<? super T> procedure);
@Override
StackIterable<T> select(Predicate<? super T> predicate);
@Override
<P> StackIterable<T> selectWith(Predicate2<? super T, ? super P> predicate, P parameter);
@Override
StackIterable<T> reject(Predicate<? super T> predicate);
@Override
<P> StackIterable<T> rejectWith(Predicate2<? super T, ? super P> predicate, P parameter);
@Override
<S> StackIterable<S> selectInstancesOf(Class<S> clazz);
@Override
PartitionStack<T> partition(Predicate<? super T> predicate);
@Override
<P> PartitionStack<T> partitionWith(Predicate2<? super T, ? super P> predicate, P parameter);
@Override
<V> StackIterable<V> collect(Function<? super T, ? extends V> function);
@Override
BooleanStack collectBoolean(BooleanFunction<? super T> booleanFunction);
@Override
ByteStack collectByte(ByteFunction<? super T> byteFunction);
@Override
CharStack collectChar(CharFunction<? super T> charFunction);
@Override
DoubleStack collectDouble(DoubleFunction<? super T> doubleFunction);
@Override
FloatStack collectFloat(FloatFunction<? super T> floatFunction);
@Override
IntStack collectInt(IntFunction<? super T> intFunction);
@Override
LongStack collectLong(LongFunction<? super T> longFunction);
@Override
ShortStack collectShort(ShortFunction<? super T> shortFunction);
@Override
<P, V> StackIterable<V> collectWith(Function2<? super T, ? super P, ? extends V> function, P parameter);
@Override
<V> StackIterable<V> collectIf(Predicate<? super T> predicate, Function<? super T, ? extends V> function);
/**
* @since 9.1.
*/
@Override
default <V> StackIterable<V> collectWithIndex(ObjectIntToObjectFunction<? super T, ? extends V> function)
{
int[] index = {0};
return this.collect(each -> function.valueOf(each, index[0]++));
}
@Override
<V> StackIterable<V> flatCollect(Function<? super T, ? extends Iterable<V>> function);
/**
* @since 9.2
*/
@Override
default <P, V> StackIterable<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);
@Override
<S> StackIterable<Pair<T, S>> zip(Iterable<S> that);
@Override
StackIterable<Pair<T, Integer>> zipWithIndex();
/**
* Converts the StackIterable to an immutable implementation. Returns this for immutable stacks.
*
* @since 5.0
*/
ImmutableStack<T> toImmutable();
}