-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathstream.html
More file actions
1580 lines (1384 loc) · 70.3 KB
/
stream.html
File metadata and controls
1580 lines (1384 loc) · 70.3 KB
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>stream.stream API documentation</title>
<meta name="description" content="" />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>stream.stream</code></h1>
</header>
<section id="section-intro">
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">from functools import cmp_to_key
import random
from .util.iterators import IteratorUtils
from .util.optional import Optional
class Stream():
"""
A sequence of elements supporting sequential operations.
The following example illustrates an aggregate operation using
Stream:
result = Stream(elements)
.filter(lambda w: w.getColor() == RED)
.map(lambda w: w.getWeight())
.sum()
A stream pipeline, like the elements example above, can be viewed as a query on the stream source.
A stream should be operated on (invoking an intermediate or terminal stream operation) only once. This rules out, for example, "forked" streams, where the same source feeds two or more pipelines, or multiple traversals of the same stream. A stream implementation may raise Exception if it detects that the stream is being reused.
"""
"""
Static Methods
"""
@staticmethod
def empty():
'''
Returns an empty sequential Stream.
:return: an empty sequential stream
'''
return Stream([])
@staticmethod
def of(elem):
'''
Returns a sequential Stream containing a single element.
:param T elem: the single element
:return: a singleton sequential stream
'''
return Stream(iter([elem]))
@staticmethod
def of(*elements):
'''
Returns a sequential ordered stream whose elements are the specified values.
:param *T elements: the elements of the new stream
:return: the new stream
'''
return Stream(iter(list(elements)))
@staticmethod
def ofNullable(elem):
'''
Returns a sequential Stream containing a single element, if non-null, otherwise returns an empty Stream.
:param T elem: the single element
:return: a stream with a single element if the specified element is non-null, otherwise an empty stream
'''
return Stream.of(elem) if elem is not None else Stream.empty()
@staticmethod
def iterate(seed, operator):
'''
Returns an infinite sequential ordered Stream produced by iterative application of a function f to an initial element seed, producing a Stream consisting of seed, f(seed), f(f(seed)), etc.
:param T seed: the initial element
:param UnaryOperator operator: a function to be applied to the previous element to produce a new element
:return: a new sequential Stream
'''
return Stream(IteratorUtils.iterate(seed, operator))
@staticmethod
def generate(supplier):
'''
Returns an infinite sequential unordered stream where each element is generated by the provided Supplier. This is suitable for generating constant streams, streams of random elements, etc.
:param Supplier supplier: the Supplier of generated elements
:return: a new infinite sequential unordered Stream
'''
return Stream(IteratorUtils.generate(supplier))
@staticmethod
def concat(*streams):
'''
Creates a lazily concatenated stream whose elements are all the elements of the first stream followed by all the elements of the second stream and so on.
:param *Stream streams: the streams to concat
:return: the concatenation of the input streams
'''
return Stream(IteratorUtils.concat(*streams))
@staticmethod
def constant(element):
'''
Return an infinite sequential stream where each element is the passed element
:param T elem: the element
:return: the new stream made of @element
'''
return Stream.generate(lambda: element)
"""
Normal Methods
"""
def __init__(self, iterable):
self.iterable = iterable
def filter(self, predicate):
'''
Returns a stream consisting of the elements of this stream, additionally performing the provided action on each element as elements are consumed from the resulting stream.
:param function predicate: predicate to apply to each element to determine if it should be included
:return: self
'''
self.iterable = IteratorUtils.filter(self.iterable, predicate)
return self
def map(self, mapper):
'''
Returns a stream consisting of the results of applying the given function to the elements of this stream.
:param function mapper: function to apply to each element
:return: self
'''
self.iterable = IteratorUtils.map(self.iterable, mapper)
return self
def flatMap(self, flatMapper):
'''
Returns a stream consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element. Each mapped stream is closed after its contents have been placed into this stream. (If a mapped stream is null an empty stream is used, instead.)
:param function flatMapper: function to apply to each element which produces a stream of new values
:return: self
'''
self.iterable = IteratorUtils.flatMap(self.iterable, flatMapper)
return self
def distinct(self):
'''
Returns a stream consisting of the distinct elements of this stream.
:return: self
'''
self.iterable = IteratorUtils.distinct(self.iterable)
return self
def limit(self, count):
'''
Returns a stream consisting of the elements of this stream, truncated to be no longer than maxSize in length.
:param int count: the number of elements the stream should be limited to
:return: self
'''
self.iterable = IteratorUtils.limit(self.iterable, count)
return self
def skip(self, count):
'''
Returns a stream consisting of the remaining elements of this stream after discarding the first n elements of the stream. If this stream contains fewer than n elements then an empty stream will be returned.
:param int count: the number of leading elements to skip
:return: self
'''
self.iterable = IteratorUtils.skip(self.iterable, count)
return self
def takeWhile(self, predicate):
'''
Returns a stream consisting of the longest prefix of elements taken from this stream that match the given predicate.
:param Predicate predicate: predicate to apply to elements to determine the longest prefix of elements.
:return: self
'''
self.iterable = IteratorUtils.takeWhile(self.iterable, predicate)
return self
def dropWhile(self, predicate):
'''
Returns a stream consisting of the remaining elements of this stream after dropping the longest prefix of elements that match the given predicate.
:param Predicate predicate: predicate to apply to elements to determine the longest prefix of elements.
:return: self
'''
self.iterable = IteratorUtils.dropWhile(self.iterable, predicate)
return self
"""
From here this method mustn't be called on infinite stream
"""
def sorted(self, comparator=None):
'''
Returns a stream consisting of the elements of this stream, sorted according to the provided Comparator.
:param Comparator comparator: Comparator to be used to compare stream elements - if null default comparator is used
:return: self
'''
self.iterable = iter(sorted(
self.iterable, key=cmp_to_key(comparator))) if comparator is not None else iter(sorted(
self.iterable))
return self
def peek(self, consumer):
'''
Returns a stream consisting of the elements of this stream, additionally performing the provided action on each element as elements are consumed from the resulting stream.
:param Consumer consumer: action to perform on the elements as they are consumed from the stream
:return: self
'''
self.iterable = IteratorUtils.peek(self.iterable, consumer)
return self
def forEach(self, function):
'''
Performs an action for each element of this stream.
:param Function function: action to perform on the elements
:return: None
'''
for elem in self.iterable:
function(elem)
def anyMatch(self, predicate):
'''
Returns whether any elements of this stream match the provided predicate.
:param Predicate predicate: predicate to apply to elements of this stream
:return: True if any elements of the stream match the provided predicate, otherwise False
'''
return any([predicate(elem) for elem in self.iterable])
def allMatch(self, predicate):
'''
Returns whether all elements of this stream match the provided predicate.
:param Predicate predicate: predicate to apply to elements of this stream
:return: True if either all elements of the stream match the provided predicate or the stream is empty, otherwise False
'''
return all([predicate(elem) for elem in self.iterable])
def noneMatch(self, predicate):
'''
Returns whether no elements of this stream match the provided predicate.
:param Predicate predicate: predicate to apply to elements of this stream
:return: True if either no elements of the stream match the provided predicate or the stream is empty, otherwise False
'''
return not self.anyMatch(predicate)
def findFirst(self, predicate=None):
'''
Returns an Optional describing the first element (with optional filtering by a given predicate) of this stream, or an empty Optional if the stream is empty. If the stream has no encounter order, then any element may be returned.
:param Predicate predicate: optional predicate to apply to elements of this stream
:return: an Optional describing the first element of this stream, or an empty Optional if the stream is empty
'''
if predicate:
self.filter(predicate)
for elem in self.iterable:
return Optional.of(elem)
return Optional.ofNullable(None)
def findAny(self):
'''
Returns an Optional describing some element of the stream, or an empty Optional if the stream is empty.
:return: an Optional describing some element of this stream, or an empty Optional if the stream is empty
'''
return self.findFirst()
def reduce(self, accumulator, identity=None):
'''
Performs a reduction on the elements of this stream, using the provided identity value and an associative accumulation function, and returns the reduced value.
:param T identity: the identity value for the accumulating function - if not specified it will be the first element of the stream
:param Accumulator accumulator: function for combining two values
:return: the result of reduction
'''
result = identity
for elem in self.iterable:
if(result is None):
result = elem
else:
result = accumulator(result, elem)
return Optional.ofNullable(result)
def min(self, comparator=None):
'''
Returns the minimum element of this stream according to the provided Comparator. This is a special case of a reduction.
:param Comparator comparator: Comparator to compare elements of this stream - if null default comparator is used
:return: an Optional describing the minimum element of this stream, or an empty Optional if the stream is empty
'''
elements = list(self.iterable)
if len(elements) == 0:
return Optional.empty()
return Optional.ofNullable(min(elements, key=cmp_to_key(comparator), default=None)) if comparator is not None else Optional.ofNullable(min(elements, default=None))
def max(self, comparator=None):
'''
Returns the maximum element of this stream according to the provided Comparator. This is a special case of a reduction.
:param Comparator comparator: Comparator to compare elements of this stream - if null default comparator is used
:return: an Optional describing the maximum element of this stream, or an empty Optional if the stream is empty
'''
elements = list(self.iterable)
if len(elements) == 0:
return Optional.empty()
return Optional.ofNullable(max(elements, key=cmp_to_key(comparator))) if comparator is not None else Optional.ofNullable(max(elements))
def sum(self):
'''
Returns the sum of all elements of this stream. This is a special case of a reduction.
:return: an Optional describing the sum of all the elements of this stream, or an empty Optional if the stream is empty
'''
return self.reduce(lambda x, y: x + y)
def count(self):
'''
Returns the count of elements in this stream. This is a special case of a reduction.
:return: the count of elements in this stream
'''
count = 0
for elem in self.iterable:
count += 1
return count
def toList(self):
'''
Returns a list with the elements in this stream.
:return: the list of elements in this stream
'''
return list(self.iterable)
def toSet(self):
'''
Returns a set with the elements in this stream.
:return: the set of elements in this stream
'''
return set(self.iterable)
def toNumberStream(self):
from .numbers import NumberStream
return NumberStream(self)
def toBooleanStream(self):
from .booleans import BooleanStream
return BooleanStream(self)
def __iter__(self):
'''
Returns an iterator over the elements in this stream.
:return: the iterator over the elements in this stream
'''
return iter(self.iterable)
def __eq__(self, value):
'''
Check if this stream is equal to the specified stream
:return: True if the streams match, False otherwise
'''
return self.toSet() == value.toSet()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="stream.stream.Stream"><code class="flex name class">
<span>class <span class="ident">Stream</span></span>
<span>(</span><span>iterable)</span>
</code></dt>
<dd>
<div class="desc"><p>A sequence of elements supporting sequential operations.</p>
<p>The following example illustrates an aggregate operation using</p>
<h2 id="stream">Stream</h2>
<p>result = Stream(elements)
.filter(lambda w: w.getColor() == RED)
.map(lambda w: w.getWeight())
.sum()</p>
<p>A stream pipeline, like the elements example above, can be viewed as a query on the stream source.</p>
<p>A stream should be operated on (invoking an intermediate or terminal stream operation) only once. This rules out, for example, "forked" streams, where the same source feeds two or more pipelines, or multiple traversals of the same stream. A stream implementation may raise Exception if it detects that the stream is being reused.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class Stream():
"""
A sequence of elements supporting sequential operations.
The following example illustrates an aggregate operation using
Stream:
result = Stream(elements)
.filter(lambda w: w.getColor() == RED)
.map(lambda w: w.getWeight())
.sum()
A stream pipeline, like the elements example above, can be viewed as a query on the stream source.
A stream should be operated on (invoking an intermediate or terminal stream operation) only once. This rules out, for example, "forked" streams, where the same source feeds two or more pipelines, or multiple traversals of the same stream. A stream implementation may raise Exception if it detects that the stream is being reused.
"""
"""
Static Methods
"""
@staticmethod
def empty():
'''
Returns an empty sequential Stream.
:return: an empty sequential stream
'''
return Stream([])
@staticmethod
def of(elem):
'''
Returns a sequential Stream containing a single element.
:param T elem: the single element
:return: a singleton sequential stream
'''
return Stream(iter([elem]))
@staticmethod
def of(*elements):
'''
Returns a sequential ordered stream whose elements are the specified values.
:param *T elements: the elements of the new stream
:return: the new stream
'''
return Stream(iter(list(elements)))
@staticmethod
def ofNullable(elem):
'''
Returns a sequential Stream containing a single element, if non-null, otherwise returns an empty Stream.
:param T elem: the single element
:return: a stream with a single element if the specified element is non-null, otherwise an empty stream
'''
return Stream.of(elem) if elem is not None else Stream.empty()
@staticmethod
def iterate(seed, operator):
'''
Returns an infinite sequential ordered Stream produced by iterative application of a function f to an initial element seed, producing a Stream consisting of seed, f(seed), f(f(seed)), etc.
:param T seed: the initial element
:param UnaryOperator operator: a function to be applied to the previous element to produce a new element
:return: a new sequential Stream
'''
return Stream(IteratorUtils.iterate(seed, operator))
@staticmethod
def generate(supplier):
'''
Returns an infinite sequential unordered stream where each element is generated by the provided Supplier. This is suitable for generating constant streams, streams of random elements, etc.
:param Supplier supplier: the Supplier of generated elements
:return: a new infinite sequential unordered Stream
'''
return Stream(IteratorUtils.generate(supplier))
@staticmethod
def concat(*streams):
'''
Creates a lazily concatenated stream whose elements are all the elements of the first stream followed by all the elements of the second stream and so on.
:param *Stream streams: the streams to concat
:return: the concatenation of the input streams
'''
return Stream(IteratorUtils.concat(*streams))
@staticmethod
def constant(element):
'''
Return an infinite sequential stream where each element is the passed element
:param T elem: the element
:return: the new stream made of @element
'''
return Stream.generate(lambda: element)
"""
Normal Methods
"""
def __init__(self, iterable):
self.iterable = iterable
def filter(self, predicate):
'''
Returns a stream consisting of the elements of this stream, additionally performing the provided action on each element as elements are consumed from the resulting stream.
:param function predicate: predicate to apply to each element to determine if it should be included
:return: self
'''
self.iterable = IteratorUtils.filter(self.iterable, predicate)
return self
def map(self, mapper):
'''
Returns a stream consisting of the results of applying the given function to the elements of this stream.
:param function mapper: function to apply to each element
:return: self
'''
self.iterable = IteratorUtils.map(self.iterable, mapper)
return self
def flatMap(self, flatMapper):
'''
Returns a stream consisting of the results of replacing each element of this stream with the contents of a mapped stream produced by applying the provided mapping function to each element. Each mapped stream is closed after its contents have been placed into this stream. (If a mapped stream is null an empty stream is used, instead.)
:param function flatMapper: function to apply to each element which produces a stream of new values
:return: self
'''
self.iterable = IteratorUtils.flatMap(self.iterable, flatMapper)
return self
def distinct(self):
'''
Returns a stream consisting of the distinct elements of this stream.
:return: self
'''
self.iterable = IteratorUtils.distinct(self.iterable)
return self
def limit(self, count):
'''
Returns a stream consisting of the elements of this stream, truncated to be no longer than maxSize in length.
:param int count: the number of elements the stream should be limited to
:return: self
'''
self.iterable = IteratorUtils.limit(self.iterable, count)
return self
def skip(self, count):
'''
Returns a stream consisting of the remaining elements of this stream after discarding the first n elements of the stream. If this stream contains fewer than n elements then an empty stream will be returned.
:param int count: the number of leading elements to skip
:return: self
'''
self.iterable = IteratorUtils.skip(self.iterable, count)
return self
def takeWhile(self, predicate):
'''
Returns a stream consisting of the longest prefix of elements taken from this stream that match the given predicate.
:param Predicate predicate: predicate to apply to elements to determine the longest prefix of elements.
:return: self
'''
self.iterable = IteratorUtils.takeWhile(self.iterable, predicate)
return self
def dropWhile(self, predicate):
'''
Returns a stream consisting of the remaining elements of this stream after dropping the longest prefix of elements that match the given predicate.
:param Predicate predicate: predicate to apply to elements to determine the longest prefix of elements.
:return: self
'''
self.iterable = IteratorUtils.dropWhile(self.iterable, predicate)
return self
"""
From here this method mustn't be called on infinite stream
"""
def sorted(self, comparator=None):
'''
Returns a stream consisting of the elements of this stream, sorted according to the provided Comparator.
:param Comparator comparator: Comparator to be used to compare stream elements - if null default comparator is used
:return: self
'''
self.iterable = iter(sorted(
self.iterable, key=cmp_to_key(comparator))) if comparator is not None else iter(sorted(
self.iterable))
return self
def peek(self, consumer):
'''
Returns a stream consisting of the elements of this stream, additionally performing the provided action on each element as elements are consumed from the resulting stream.
:param Consumer consumer: action to perform on the elements as they are consumed from the stream
:return: self
'''
self.iterable = IteratorUtils.peek(self.iterable, consumer)
return self
def forEach(self, function):
'''
Performs an action for each element of this stream.
:param Function function: action to perform on the elements
:return: None
'''
for elem in self.iterable:
function(elem)
def anyMatch(self, predicate):
'''
Returns whether any elements of this stream match the provided predicate.
:param Predicate predicate: predicate to apply to elements of this stream
:return: True if any elements of the stream match the provided predicate, otherwise False
'''
return any([predicate(elem) for elem in self.iterable])
def allMatch(self, predicate):
'''
Returns whether all elements of this stream match the provided predicate.
:param Predicate predicate: predicate to apply to elements of this stream
:return: True if either all elements of the stream match the provided predicate or the stream is empty, otherwise False
'''
return all([predicate(elem) for elem in self.iterable])
def noneMatch(self, predicate):
'''
Returns whether no elements of this stream match the provided predicate.
:param Predicate predicate: predicate to apply to elements of this stream
:return: True if either no elements of the stream match the provided predicate or the stream is empty, otherwise False
'''
return not self.anyMatch(predicate)
def findFirst(self, predicate=None):
'''
Returns an Optional describing the first element (with optional filtering by a given predicate) of this stream, or an empty Optional if the stream is empty. If the stream has no encounter order, then any element may be returned.
:param Predicate predicate: optional predicate to apply to elements of this stream
:return: an Optional describing the first element of this stream, or an empty Optional if the stream is empty
'''
if predicate:
self.filter(predicate)
for elem in self.iterable:
return Optional.of(elem)
return Optional.ofNullable(None)
def findAny(self):
'''
Returns an Optional describing some element of the stream, or an empty Optional if the stream is empty.
:return: an Optional describing some element of this stream, or an empty Optional if the stream is empty
'''
return self.findFirst()
def reduce(self, accumulator, identity=None):
'''
Performs a reduction on the elements of this stream, using the provided identity value and an associative accumulation function, and returns the reduced value.
:param T identity: the identity value for the accumulating function - if not specified it will be the first element of the stream
:param Accumulator accumulator: function for combining two values
:return: the result of reduction
'''
result = identity
for elem in self.iterable:
if(result is None):
result = elem
else:
result = accumulator(result, elem)
return Optional.ofNullable(result)
def min(self, comparator=None):
'''
Returns the minimum element of this stream according to the provided Comparator. This is a special case of a reduction.
:param Comparator comparator: Comparator to compare elements of this stream - if null default comparator is used
:return: an Optional describing the minimum element of this stream, or an empty Optional if the stream is empty
'''
elements = list(self.iterable)
if len(elements) == 0:
return Optional.empty()
return Optional.ofNullable(min(elements, key=cmp_to_key(comparator), default=None)) if comparator is not None else Optional.ofNullable(min(elements, default=None))
def max(self, comparator=None):
'''
Returns the maximum element of this stream according to the provided Comparator. This is a special case of a reduction.
:param Comparator comparator: Comparator to compare elements of this stream - if null default comparator is used
:return: an Optional describing the maximum element of this stream, or an empty Optional if the stream is empty
'''
elements = list(self.iterable)
if len(elements) == 0:
return Optional.empty()
return Optional.ofNullable(max(elements, key=cmp_to_key(comparator))) if comparator is not None else Optional.ofNullable(max(elements))
def sum(self):
'''
Returns the sum of all elements of this stream. This is a special case of a reduction.
:return: an Optional describing the sum of all the elements of this stream, or an empty Optional if the stream is empty
'''
return self.reduce(lambda x, y: x + y)
def count(self):
'''
Returns the count of elements in this stream. This is a special case of a reduction.
:return: the count of elements in this stream
'''
count = 0
for elem in self.iterable:
count += 1
return count
def toList(self):
'''
Returns a list with the elements in this stream.
:return: the list of elements in this stream
'''
return list(self.iterable)
def toSet(self):
'''
Returns a set with the elements in this stream.
:return: the set of elements in this stream
'''
return set(self.iterable)
def toNumberStream(self):
from .numbers import NumberStream
return NumberStream(self)
def toBooleanStream(self):
from .booleans import BooleanStream
return BooleanStream(self)
def __iter__(self):
'''
Returns an iterator over the elements in this stream.
:return: the iterator over the elements in this stream
'''
return iter(self.iterable)
def __eq__(self, value):
'''
Check if this stream is equal to the specified stream
:return: True if the streams match, False otherwise
'''
return self.toSet() == value.toSet()</code></pre>
</details>
<h3>Subclasses</h3>
<ul class="hlist">
<li><a title="stream.booleans.BooleanStream" href="booleans.html#stream.booleans.BooleanStream">BooleanStream</a></li>
<li><a title="stream.numbers.NumberStream" href="numbers.html#stream.numbers.NumberStream">NumberStream</a></li>
</ul>
<h3>Static methods</h3>
<dl>
<dt id="stream.stream.Stream.concat"><code class="name flex">
<span>def <span class="ident">concat</span></span>(<span>*streams)</span>
</code></dt>
<dd>
<div class="desc"><p>Creates a lazily concatenated stream whose elements are all the elements of the first stream followed by all the elements of the second stream and so on.</p>
<p>:param *Stream streams: the streams to concat
:return: the concatenation of the input streams</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def concat(*streams):
'''
Creates a lazily concatenated stream whose elements are all the elements of the first stream followed by all the elements of the second stream and so on.
:param *Stream streams: the streams to concat
:return: the concatenation of the input streams
'''
return Stream(IteratorUtils.concat(*streams))</code></pre>
</details>
</dd>
<dt id="stream.stream.Stream.constant"><code class="name flex">
<span>def <span class="ident">constant</span></span>(<span>element)</span>
</code></dt>
<dd>
<div class="desc"><p>Return an infinite sequential stream where each element is the passed element</p>
<p>:param T elem: the element
:return: the new stream made of @element</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def constant(element):
'''
Return an infinite sequential stream where each element is the passed element
:param T elem: the element
:return: the new stream made of @element
'''
return Stream.generate(lambda: element)</code></pre>
</details>
</dd>
<dt id="stream.stream.Stream.empty"><code class="name flex">
<span>def <span class="ident">empty</span></span>(<span>)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns an empty sequential Stream.</p>
<p>:return: an empty sequential stream</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def empty():
'''
Returns an empty sequential Stream.
:return: an empty sequential stream
'''
return Stream([])</code></pre>
</details>
</dd>
<dt id="stream.stream.Stream.generate"><code class="name flex">
<span>def <span class="ident">generate</span></span>(<span>supplier)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns an infinite sequential unordered stream where each element is generated by the provided Supplier. This is suitable for generating constant streams, streams of random elements, etc.</p>
<p>:param Supplier supplier: the Supplier of generated elements
:return: a new infinite sequential unordered Stream</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def generate(supplier):
'''
Returns an infinite sequential unordered stream where each element is generated by the provided Supplier. This is suitable for generating constant streams, streams of random elements, etc.
:param Supplier supplier: the Supplier of generated elements
:return: a new infinite sequential unordered Stream
'''
return Stream(IteratorUtils.generate(supplier))</code></pre>
</details>
</dd>
<dt id="stream.stream.Stream.iterate"><code class="name flex">
<span>def <span class="ident">iterate</span></span>(<span>seed, operator)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns an infinite sequential ordered Stream produced by iterative application of a function f to an initial element seed, producing a Stream consisting of seed, f(seed), f(f(seed)), etc.</p>
<p>:param T seed: the initial element
:param UnaryOperator operator: a function to be applied to the previous element to produce a new element
:return: a new sequential Stream</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def iterate(seed, operator):
'''
Returns an infinite sequential ordered Stream produced by iterative application of a function f to an initial element seed, producing a Stream consisting of seed, f(seed), f(f(seed)), etc.
:param T seed: the initial element
:param UnaryOperator operator: a function to be applied to the previous element to produce a new element
:return: a new sequential Stream
'''
return Stream(IteratorUtils.iterate(seed, operator))</code></pre>
</details>
</dd>
<dt id="stream.stream.Stream.of"><code class="name flex">
<span>def <span class="ident">of</span></span>(<span>*elements)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns a sequential ordered stream whose elements are the specified values.</p>
<p>:param *T elements: the elements of the new stream
:return: the new stream</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def of(*elements):
'''
Returns a sequential ordered stream whose elements are the specified values.
:param *T elements: the elements of the new stream
:return: the new stream
'''
return Stream(iter(list(elements)))</code></pre>
</details>
</dd>
<dt id="stream.stream.Stream.ofNullable"><code class="name flex">
<span>def <span class="ident">ofNullable</span></span>(<span>elem)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns a sequential Stream containing a single element, if non-null, otherwise returns an empty Stream.</p>
<p>:param T elem: the single element
:return: a stream with a single element if the specified element is non-null, otherwise an empty stream</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@staticmethod
def ofNullable(elem):
'''
Returns a sequential Stream containing a single element, if non-null, otherwise returns an empty Stream.
:param T elem: the single element
:return: a stream with a single element if the specified element is non-null, otherwise an empty stream
'''
return Stream.of(elem) if elem is not None else Stream.empty()</code></pre>
</details>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="stream.stream.Stream.allMatch"><code class="name flex">
<span>def <span class="ident">allMatch</span></span>(<span>self, predicate)</span>
</code></dt>
<dd>
<div class="desc"><p>Returns whether all elements of this stream match the provided predicate.</p>
<p>:param Predicate predicate: predicate to apply to elements of this stream
:return: True if either all elements of the stream match the provided predicate or the stream is empty, otherwise False</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def allMatch(self, predicate):
'''
Returns whether all elements of this stream match the provided predicate.
:param Predicate predicate: predicate to apply to elements of this stream
:return: True if either all elements of the stream match the provided predicate or the stream is empty, otherwise False
'''
return all([predicate(elem) for elem in self.iterable])</code></pre>
</details>
</dd>
<dt id="stream.stream.Stream.anyMatch"><code class="name flex">
<span>def <span class="ident">anyMatch</span></span>(<span>self, predicate)</span>
</code></dt>
<dd>