-
Notifications
You must be signed in to change notification settings - Fork 662
/
Streamable.java
248 lines (212 loc) · 6.66 KB
/
Streamable.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
/*
* Copyright 2016-2024 the original author or authors.
*
* 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
*
* https://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.
*/
package org.springframework.data.util;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.function.BiConsumer;
import java.util.function.BinaryOperator;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.stream.Collector;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
import org.springframework.util.Assert;
/**
* Simple interface to ease streamability of {@link Iterable}s.
*
* @author Oliver Gierke
* @author Christoph Strobl
* @since 2.0
*/
@FunctionalInterface
public interface Streamable<T> extends Iterable<T>, Supplier<Stream<T>> {
/**
* Returns an empty {@link Streamable}.
*
* @return will never be {@literal null}.
*/
static <T> Streamable<T> empty() {
return Collections::emptyIterator;
}
/**
* Returns a {@link Streamable} with the given elements.
*
* @param t the elements to return.
* @return
*/
@SafeVarargs
static <T> Streamable<T> of(T... t) {
return () -> Arrays.asList(t).iterator();
}
/**
* Returns a {@link Streamable} for the given {@link Iterable}.
*
* @param iterable must not be {@literal null}.
* @return
*/
static <T> Streamable<T> of(Iterable<T> iterable) {
Assert.notNull(iterable, "Iterable must not be null");
return iterable::iterator;
}
static <T> Streamable<T> of(Supplier<? extends Stream<T>> supplier) {
return LazyStreamable.of(supplier);
}
/**
* Creates a non-parallel {@link Stream} of the underlying {@link Iterable}.
*
* @return will never be {@literal null}.
*/
default Stream<T> stream() {
return StreamSupport.stream(spliterator(), false);
}
/**
* Returns a new {@link Streamable} that will apply the given {@link Function} to the current one.
*
* @param mapper must not be {@literal null}.
* @return
* @see Stream#map(Function)
*/
default <R> Streamable<R> map(Function<? super T, ? extends R> mapper) {
Assert.notNull(mapper, "Mapping function must not be null");
return Streamable.of(() -> stream().map(mapper));
}
/**
* Returns a new {@link Streamable} that will apply the given {@link Function} to the current one.
*
* @param mapper must not be {@literal null}.
* @return
* @see Stream#flatMap(Function)
*/
default <R> Streamable<R> flatMap(Function<? super T, ? extends Stream<? extends R>> mapper) {
Assert.notNull(mapper, "Mapping function must not be null");
return Streamable.of(() -> stream().flatMap(mapper));
}
/**
* Returns a new {@link Streamable} that will apply the given filter {@link Predicate} to the current one.
*
* @param predicate must not be {@literal null}.
* @return
* @see Stream#filter(Predicate)
*/
default Streamable<T> filter(Predicate<? super T> predicate) {
Assert.notNull(predicate, "Filter predicate must not be null");
return Streamable.of(() -> stream().filter(predicate));
}
/**
* Returns whether the current {@link Streamable} is empty.
*
* @return
*/
default boolean isEmpty() {
return !iterator().hasNext();
}
/**
* Creates a new {@link Streamable} from the current one and the given {@link Stream} concatenated.
*
* @param stream must not be {@literal null}.
* @return
* @since 2.1
*/
default Streamable<T> and(Supplier<? extends Stream<? extends T>> stream) {
Assert.notNull(stream, "Stream must not be null");
return Streamable.of(() -> Stream.concat(this.stream(), stream.get()));
}
/**
* Creates a new {@link Streamable} from the current one and the given values concatenated.
*
* @param others must not be {@literal null}.
* @return will never be {@literal null}.
* @since 2.2
*/
@SuppressWarnings("unchecked")
default Streamable<T> and(T... others) {
Assert.notNull(others, "Other values must not be null");
return Streamable.of(() -> Stream.concat(this.stream(), Arrays.stream(others)));
}
/**
* Creates a new {@link Streamable} from the current one and the given {@link Iterable} concatenated.
*
* @param iterable must not be {@literal null}.
* @return will never be {@literal null}.
* @since 2.2
*/
default Streamable<T> and(Iterable<? extends T> iterable) {
Assert.notNull(iterable, "Iterable must not be null");
return Streamable.of(() -> Stream.concat(this.stream(), StreamSupport.stream(iterable.spliterator(), false)));
}
/**
* Convenience method to allow adding a {@link Streamable} directly as otherwise the invocation is ambiguous between
* {@link #and(Iterable)} and {@link #and(Supplier)}.
*
* @param streamable must not be {@literal null}.
* @return will never be {@literal null}.
* @since 2.2
*/
default Streamable<T> and(Streamable<? extends T> streamable) {
return and((Supplier<? extends Stream<? extends T>>) streamable);
}
/**
* Creates a new, unmodifiable {@link List}.
*
* @return will never be {@literal null}.
* @since 2.2
*/
default List<T> toList() {
return stream().collect(StreamUtils.toUnmodifiableList());
}
/**
* Creates a new, unmodifiable {@link Set}.
*
* @return will never be {@literal null}.
* @since 2.2
*/
default Set<T> toSet() {
return stream().collect(StreamUtils.toUnmodifiableSet());
}
default Stream<T> get() {
return stream();
}
/**
* A collector to easily produce a {@link Streamable} from a {@link Stream} using {@link Collectors#toList} as
* intermediate collector.
*
* @return
* @see #toStreamable(Collector)
* @since 2.2
*/
public static <S> Collector<S, ?, Streamable<S>> toStreamable() {
return toStreamable(Collectors.toList());
}
/**
* A collector to easily produce a {@link Streamable} from a {@link Stream} and the given intermediate collector.
*
* @return
* @since 2.2
*/
@SuppressWarnings("unchecked")
public static <S, T extends Iterable<S>> Collector<S, ?, Streamable<S>> toStreamable(
Collector<S, ?, T> intermediate) {
return Collector.of( //
(Supplier<T>) intermediate.supplier(), //
(BiConsumer<T, S>) intermediate.accumulator(), //
(BinaryOperator<T>) intermediate.combiner(), //
Streamable::of);
}
}