FastStream (Quack 0.4.10.117 API)

All Superinterfaces:

java.lang.Iterable<T>

All Known Implementing Classes:

FastStream.Bucket, FastStream.Concatenated, FastStream.ConcatenatedN, FastStream.Distinct, FastStream.Filtered, FastStream.FlatMapped, FastStream.Group, FastStream.Grouped, FastStream.Mapped, FastStream.OfN, FastStream.OfSingle, FastStream.Partitioned, FastStream.Peeked, FastStream.Reversed, FastStream.Sliced, FastStream.Sorted, FastStream.Wrapped, FastStream.WrappedSpl
```
public interface FastStream<T>
extends java.lang.Iterable<T>
```
An iterable capable of stream-like operations.
Whist the Stream API is nice for some operations. There are some uses cases where a simpler approach would be faster and more efficient. This API aims to solve this.
FastStream supports multiple evaluation, however, it is undefined what will happen if the backing collections/Iterables change between evaluations. Specific operations may perform internal caching, others may not.
This Iterable implements both a fast path, and the regular iteration path.
The fast path exists via the use of Iterable.forEach(java.util.function.Consumer<? super T>). Which is recommended if you intend on consuming the entire stream. This path is much faster than regular
Created by covers1624 on 19/1/23.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`FastStream.Bucket<V>` Represents a bucket of values, of a specific size.
`static class`	`FastStream.Concatenated<T>` A `FastStream` for an `Iterable` of concatenated `Iterable`s.
`static class`	`FastStream.ConcatenatedN<T>` A `FastStream` for an array of concatenated `Iterable`s.
`static class`	`FastStream.Distinct<T>` A `FastStream` filtered using `Object.hashCode()`/`Object.equals(java.lang.Object)` identity.
`static class`	`FastStream.Filtered<T>` A `FastStream` with a filtering function applied.
`static class`	`FastStream.FlatMapped<T,R>` A `FastStream` with a flat mapping option applied to each element flattened together.
`static class`	`FastStream.Group<K,V>` Represents a Key to sequence of values in a `groupBy(java.util.function.Function<? super T, ? extends K>)` grouping.
`static class`	`FastStream.Grouped<T,K,V>` A `FastStream` of elements grouped by a specific key.
`static class`	`FastStream.Internal`
`static class`	`FastStream.Mapped<T,R>` A `FastStream` with a mapping function applied.
`static class`	`FastStream.OfN<T>` A `FastStream` for an array of elements.
`static class`	`FastStream.OfSingle<T>` A `FastStream` for a single element.
`static class`	`FastStream.Partitioned<V>` A `FastStream` of elements grouped into buckets of a specific size.
`static class`	`FastStream.Peeked<T>` A `FastStream` with a listener attached.
`static class`	`FastStream.Reversed<T>` A `FastStream` in reverse order.
`static class`	`FastStream.Sliced<T>` A `FastStream` with a min/max filter applied.
`static class`	`FastStream.Sorted<T>` A `FastStream` sorted by a comparator.
`static class`	`FastStream.TypeCheck<T,S>`
`static class`	`FastStream.Wrapped<T>` Wraps a regular `Iterable` into a `FastStream`.
`static class`	`FastStream.WrappedSpl<T>` Wraps a `Spliterator` into a `FastStream`

Field Summary

Fields
Modifier and Type Field and Description

static FastStream<?> EMPTY
Static empty instance.

Fields
Modifier and Type	Field and Description
`static FastStream<?>`	`EMPTY` Static empty instance.

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`allMatch(java.util.function.Predicate<? super T> pred)` Tests if all elements in the `FastStream` match the provided `Predicate`.
`default boolean`	`anyMatch(java.util.function.Predicate<? super T> pred)` Tests if any element in the `FastStream` matches the provided `Predicate`.
`static <T> FastStream<T>`	`concat(java.lang.Iterable<? extends T>... iterables)` Returns a concatenated `FastStream` containing the elements from the provided `Iterable` array.
`default FastStream<T>`	`concat(java.lang.Iterable<? extends T> other)` Returns a `FastStream` with the provided `Iterable` concatenated after.
`static <T> FastStream<T>`	`concatMany(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> iterables)` Returns a concatenated `FastStream` containing the elements from the provided `Iterable`s `Iterable`.
`default int`	`count()` Evaluates the stream, counting the number of elements contained within.
`default FastStream<T>`	`distinct()` Returns a `FastStream` containing all elements that are unique according to their `Object.hashCode()`/`Object.equals(java.lang.Object)` identity.
`default double`	`doubleSum(java.util.function.ToDoubleFunction<? super T> func)` Sum all elements in the stream to a double, using the provided `ToDoubleFunction` to convert each element to a double.
`static <T> FastStream<T>`	`empty()` Returns an empty `FastStream` singleton.
`default FastStream<T>`	`filter(java.util.function.Predicate<? super T> pred)` Returns a `FastStream` containing all elements that pass the provided `Predicate` filter.
`default FastStream<T>`	`filterNot(java.util.function.Predicate<? super T> pred)` Returns a `FastStream` containing all elements that fail the provided `Predicate` filter.
`default java.util.Optional<T>`	`findFirst()`
`default java.util.Optional<T>`	`findLast()`
`default T`	`first()`
`default T`	`firstOrDefault()`
`default T`	`firstOrDefault(T _default)`
`default <R> FastStream<R>`	`flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends R>> func)` Returns a `FastStream` with each element transformed by the provided `Function` concatenated together.
`default java.util.Optional<T>`	`fold(java.util.function.BinaryOperator<T> accumulator)` Returns the result of a folding operation applied to the `FastStream` contents.
`default <U> U`	`fold(U identity, java.util.function.BiFunction<? super U,? super T,? extends U> accumulator)` Returns the result of a folding operation applied to the `FastStream` contents.
`default <K> FastStream<FastStream.Group<K,T>>`	`groupBy(java.util.function.Function<? super T,? extends K> keyFunc)` Returns a `FastStream` containing all elements grouped by a key.
`default <K,V> FastStream<FastStream.Group<K,V>>`	`groupBy(java.util.function.Function<? super T,? extends K> keyFunc, java.util.function.Function<? super T,? extends V> valueFunc)` Returns a `FastStream` containing all elements grouped by a key.
`static <T> FastStream.TypeCheck<T,T>`	`infer()` Used to nudge Javac to perform looser inference on return types of some collecting functions provided in here.
`default int`	`intSum(java.util.function.ToIntFunction<? super T> func)` Sum all elements in the stream to an integer, using the provided `ToIntFunction` to convert each element to an integer.
`default boolean`	`isEmpty()` Tests if the stream is empty.
`default java.lang.String`	`join(java.lang.String sep)` Join all elements of this stream together into a `String`, separated by `sep`.
`default int`	`knownLength()` Returns the known length for the stream.
`default int`	`knownLength(boolean consumeToCalculate)` Returns the known length for the stream.
`default T`	`last()`
`default T`	`lastOrDefault()`
`default T`	`lastOrDefault(T _default)`
`default FastStream<T>`	`limit(@Range(from=-1L,to=2147483647L) int max)` Returns a `FastStream` which will let at most `max` elements pass.
`default long`	`longSum(java.util.function.ToLongFunction<? super T> func)` Sum all elements in the stream to a long, using the provided `ToLongFunction` to convert each element to a long.
`default <R> FastStream<R>`	`map(java.util.function.Function<? super T,? extends R> func)` Returns a `FastStream` with each element transformed by the provided `Function`.
`default T`	`maxBy(java.util.function.ToIntFunction<T> func)` Returns the element in the stream with the highest value returned by the provided `ToIntFunction`.
`default T`	`maxByDouble(java.util.function.ToDoubleFunction<T> func)` Returns the element in the stream with the highest value returned by the provided `ToDoubleFunction`.
`default T`	`maxByDoubleOrDefault(java.util.function.ToDoubleFunction<T> func)` Returns the element in the stream with the highest value returned by the provided `ToDoubleFunction`.
`default T`	`maxByDoubleOrDefault(java.util.function.ToDoubleFunction<T> func, T _default)` Returns the element in the stream with the highest value returned by the provided `ToDoubleFunction`.
`default T`	`maxByLong(java.util.function.ToLongFunction<T> func)` Returns the element in the stream with the highest value returned by the provided `ToLongFunction`.
`default T`	`maxByLongOrDefault(java.util.function.ToLongFunction<T> func)` Returns the element in the stream with the highest value returned by the provided `ToLongFunction`.
`default T`	`maxByLongOrDefault(java.util.function.ToLongFunction<T> func, T _default)` Returns the element in the stream with the highest value returned by the provided `ToLongFunction`.
`default T`	`maxByOrDefault(java.util.function.ToIntFunction<T> func)` Returns the element in the stream with the highest value returned by the provided `ToIntFunction`.
`default T`	`maxByOrDefault(java.util.function.ToIntFunction<T> func, T _default)` Returns the element in the stream with the highest value returned by the provided `ToIntFunction`.
`default T`	`minBy(java.util.function.ToIntFunction<T> func)` Returns the element in the stream with the lowest value returned by the provided `ToIntFunction`.
`default T`	`minByDouble(java.util.function.ToDoubleFunction<T> func)` Returns the element in the stream with the lowest value returned by the provided `ToDoubleFunction`.
`default T`	`minByDoubleOrDefault(java.util.function.ToDoubleFunction<T> func)` Returns the element in the stream with the lowest value returned by the provided `ToDoubleFunction`.
`default T`	`minByDoubleOrDefault(java.util.function.ToDoubleFunction<T> func, T _default)` Returns the element in the stream with the lowest value returned by the provided `ToDoubleFunction`.
`default T`	`minByLong(java.util.function.ToLongFunction<T> func)` Returns the element in the stream with the lowest value returned by the provided `ToLongFunction`.
`default T`	`minByLongOrDefault(java.util.function.ToLongFunction<T> func)` Returns the element in the stream with the lowest value returned by the provided `ToLongFunction`.
`default T`	`minByLongOrDefault(java.util.function.ToLongFunction<T> func, T _default)` Returns the element in the stream with the lowest value returned by the provided `ToLongFunction`.
`default T`	`minByOrDefault(java.util.function.ToIntFunction<T> func)` Returns the element in the stream with the lowest value returned by the provided `ToIntFunction`.
`default T`	`minByOrDefault(java.util.function.ToIntFunction<T> func, T _default)` Returns the element in the stream with the lowest value returned by the provided `ToIntFunction`.
`default boolean`	`noneMatch(java.util.function.Predicate<? super T> pred)` Tests if no elements in the `FastStream` match the provided `Predicate`.
`static <T> FastStream<T>`	`of()` Overload of `empty()` for convenience.
`static <T> FastStream<T>`	`of(java.lang.Iterable<? extends T> itr)` Wraps the provided `Iterable` to a `FastStream`
`static <T> FastStream<T>`	`of(java.util.Optional<? extends T> opt)` Returns a `FastStream` for an `Optional`.
`static <T> FastStream<T>`	`of(java.util.Spliterator<? extends T> itr)` Wraps the provided `Spliterator` to a `FastStream`.
`static <T> FastStream<T>`	`of(java.util.stream.Stream<? extends T> stream)` Wrap the provided Java `Stream` to a `FastStream`.
`static <T> FastStream<T>`	`of(T... things)` Returns a `FastStream` for an array of objects.
`static <T> FastStream<T>`	`of(T thing)` Returns a `FastStream` for a single object.
`static <T> FastStream<T>`	`ofNullable(T thing)` Returns a `FastStream` for a single object.
`default T`	`only()`
`default T`	`onlyOrDefault()`
`default T`	`onlyOrDefault(T _default)`
`default FastStream<FastStream<T>>`	`partition(int amount)` Returns a `FastStream` partitioned into buckets of a specific size.
`default FastStream<T>`	`peek(java.util.function.Consumer<? super T> cons)` Returns a `FastStream` which listens to all the elements which pass to the next operation.
`default FastStream<T>`	`reversed()` Returns a `FastStream` in reverse order.
`default FastStream<T>`	`skip(@Range(from=0L,to=2147483647L) int n)` Returns a `FastStream` which will skip `n` number of elements.
`default FastStream<T>`	`sorted()` Returns a `FastStream` sorted based on the elements natural sort order.
`default FastStream<T>`	`sorted(java.util.Comparator<? super T> comparator)` Returns a `FastStream` sorted based on the provided comparator.
`default java.lang.Object[]`	`toArray()` Collects this stream into an `Object`[].
`default T[]`	`toArray(java.util.function.IntFunction<T[]> func)` Collects the stream into a `T`[].
`default T[]`	`toArray(T[] arr)` Collects the stream into a `T`[].
`default com.google.common.collect.ImmutableList<T>`	`toImmutableList()` Collects this stream into a `ImmutableList`.
`default <R> com.google.common.collect.ImmutableList<R>`	`toImmutableList(FastStream.TypeCheck<R,? super T> check)` Collects this stream into a `ImmutableList`.
`default <K,V> com.google.common.collect.ImmutableMap<K,V>`	`toImmutableMap(java.util.function.Function<? super T,? extends K> kFunc, java.util.function.Function<? super T,? extends V> vFunc)` Collects this stream into an `ImmutableMap`.
`default <K,V> com.google.common.collect.ImmutableMap<K,V>`	`toImmutableMap(java.util.function.Function<? super T,? extends K> kFunc, java.util.function.Function<? super T,? extends V> vFunc, java.util.function.BinaryOperator<V> mergeFunc)` Collects this stream into an `ImmutableMap`.
`default com.google.common.collect.ImmutableSet<T>`	`toImmutableSet()` Collects this stream into a `ImmutableSet`.
`default <R> com.google.common.collect.ImmutableSet<R>`	`toImmutableSet(FastStream.TypeCheck<R,? super T> check)` Collects this stream into a `ImmutableSet`.
`default <K,V> java.util.LinkedHashMap<K,V>`	`toLinkedHashMap(java.util.function.Function<? super T,? extends K> kFunc, java.util.function.Function<? super T,? extends V> vFunc)` Collects this stream into a `LinkedHashMap`.
`default <K,V> java.util.LinkedHashMap<K,V>`	`toLinkedHashMap(java.util.function.Function<? super T,? extends K> kFunc, java.util.function.Function<? super T,? extends V> vFunc, java.util.function.BinaryOperator<V> mergeFunc)` Collects this stream into a `LinkedHashMap`.
`default java.util.LinkedHashSet<T>`	`toLinkedHashSet()` Collects this stream into a `LinkedHashSet`.
`default <R> java.util.LinkedHashSet<R>`	`toLinkedHashSet(FastStream.TypeCheck<R,? super T> check)` Collects this stream into a `LinkedHashSet`.
`default java.util.LinkedList<T>`	`toLinkedList()` Collects this stream into a `LinkedList`.
`default <R> java.util.LinkedList<R>`	`toLinkedList(FastStream.TypeCheck<R,? super T> check)` Collects this stream into a `LinkedList`.
`default java.util.ArrayList<T>`	`toList()` Collects this stream into an `ArrayList`.
`default <R> java.util.List<R>`	`toList(FastStream.TypeCheck<R,? super T> check)` Collects this stream into an `ArrayList`.
`default <K,V> java.util.HashMap<K,V>`	`toMap(java.util.function.Function<? super T,? extends K> kFunc, java.util.function.Function<? super T,? extends V> vFunc)` Collects this stream into a `HashMap`.
`default <K,V> java.util.HashMap<K,V>`	`toMap(java.util.function.Function<? super T,? extends K> kFunc, java.util.function.Function<? super T,? extends V> vFunc, java.util.function.BinaryOperator<V> mergeFunc)` Collects this stream into a `HashMap`.
`default <K,V,M extends java.util.Map<K,V>> M`	`toMap(M map, java.util.function.Function<? super T,? extends K> kFunc, java.util.function.Function<? super T,? extends V> vFunc)` Collects this stream into the provided `Map`.
`default <K,V,M extends java.util.Map<K,V>> M`	`toMap(M map, java.util.function.Function<? super T,? extends K> kFunc, java.util.function.Function<? super T,? extends V> vFunc, java.util.function.BinaryOperator<V> mergeFunc)` Collects this stream into the provided `Map`.
`default java.util.HashSet<T>`	`toSet()` Collects this stream into a `HashSet`.
`default <R> java.util.HashSet<R>`	`toSet(FastStream.TypeCheck<R,? super T> check)` Collects this stream into a `HashSet`.

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Field Detail
  - EMPTY
```
static final FastStream<?> EMPTY
```
    Static empty instance. You want empty() for return type inference.
- Method Detail
  - empty
```
static <T> FastStream<T> empty()
```
    Returns an empty FastStream singleton.
    
    Returns:
    
    An empty FastStream.
  - of
```
static <T> FastStream<T> of()
```
    Overload of empty() for convenience.
    
    Returns:
    
    An empty FastStream.
  - of
```
static <T> FastStream<T> of(java.lang.Iterable<? extends T> itr)
```
    Wraps the provided Iterable to a FastStream
    This method may return the same object if it's already a FastStream, the empty singleton if it's a Collection and provably empty, or a new Wrapped instance.
    The Wrapped instance is careful to expose the underlying iterator of the provided Iterable, as well as forward calls to Iterable.forEach(java.util.function.Consumer<? super T>)
    
    Parameters:
    
    itr - The Iterable to wrap.
    
    Returns:
    
    The wrapped Iterable.
  - of
```
static <T> FastStream<T> of(java.util.Spliterator<? extends T> itr)
```
    Wraps the provided Spliterator to a FastStream.
    
    Parameters:
    
    itr - The Spliterator.
    
    Returns:
    
    The FastStream
  - of
```
static <T> FastStream<T> of(java.util.stream.Stream<? extends T> stream)
```
    Wrap the provided Java Stream to a FastStream.
    This method is provided to support wrapping API's which only provide Stream outputs, into FastStream. This implicitly uses the of(Spliterator).
    Where possible, raw Spliterator or Iterator inputs should be used.
    NOTE: Using Java Stream operations combined with FastStream operations may result in poor performance.
    
    Parameters:
    
    stream - The stream.
    
    Returns:
    
    The FastStream
  - of
```
static <T> FastStream<T> of(T thing)
```
    Returns a FastStream for a single object.
    
    Parameters:
    
    thing - The thing.
    
    Returns:
    
    The FastStream for the single object.
  - ofNullable
```
static <T> FastStream<T> ofNullable(@Nullable
                                    T thing)
```
    Returns a FastStream for a single object.
    If the provided object is null, an empty FastStream is returned.
    
    Parameters:
    
    thing - The thing.
    
    Returns:
    
    The FastStream for the single object or empty.
  - of
```
static <T> FastStream<T> of(java.util.Optional<? extends T> opt)
```
    Returns a FastStream for an Optional.
    If the provided Optional is not Optional.isPresent(), an empty FastStream is returned.
    
    Parameters:
    
    opt - The Optional.
    
    Returns:
    
    The FastStream for the Optional or empty.
  - of
```
@SafeVarargs
static <T> FastStream<T> of(T... things)
```
    Returns a FastStream for an array of objects.
    This method is preferred over a wrapper such as Arrays.asList(T...) due to fewer allocations and virtual/interface calls.
    
    Parameters:
    
    things - The thing.
    
    Returns:
    
    The FastStream for the objects.
  - concat
```
@SafeVarargs
static <T> FastStream<T> concat(java.lang.Iterable<? extends T>... iterables)
```
    Returns a concatenated FastStream containing the elements from the provided Iterable array.
    
    Parameters:
    
    iterables - The Iterables to concatenate.
    
    Returns:
    
    The concatenated FastStream.
  - concatMany
```
static <T> FastStream<T> concatMany(java.lang.Iterable<? extends java.lang.Iterable<? extends T>> iterables)
```
    Returns a concatenated FastStream containing the elements from the provided Iterables Iterable.
    
    Parameters:
    
    iterables - The Iterables to concatenate.
    
    Returns:
    
    The concatenated FastStream.
  - concat
```
default FastStream<T> concat(java.lang.Iterable<? extends T> other)
```
    Returns a FastStream with the provided Iterable concatenated after.
    
    Parameters:
    
    other - The other
    
    Returns:
    
    THe concatenated FastStream.
  - filter
```
default FastStream<T> filter(java.util.function.Predicate<? super T> pred)
```
    Returns a FastStream containing all elements that pass the provided Predicate filter.
    
    Parameters:
    
    pred - The Predicate to apply.
    
    Returns:
    
    The filtered FastStream.
  - filterNot
```
default FastStream<T> filterNot(java.util.function.Predicate<? super T> pred)
```
    Returns a FastStream containing all elements that fail the provided Predicate filter.
    
    Parameters:
    
    pred - The Predicate to apply.
    
    Returns:
    
    The filtered FastStream.
  - map
```
default <R> FastStream<R> map(java.util.function.Function<? super T,? extends R> func)
```
    Returns a FastStream with each element transformed by the provided Function.
    
    Parameters:
    
    func - The Function to apply.
    
    Returns:
    
    The transformed FastStream.
  - flatMap
```
default <R> FastStream<R> flatMap(java.util.function.Function<? super T,? extends java.lang.Iterable<? extends R>> func)
```
    Returns a FastStream with each element transformed by the provided Function concatenated together.
    
    Parameters:
    
    func - The Function to apply producing the Iterable for concatenation.
    
    Returns:
    
    The flat mapped FastStream.
  - distinct
```
default FastStream<T> distinct()
```
    Returns a FastStream containing all elements that are unique according to their Object.hashCode()/Object.equals(java.lang.Object) identity.
    
    Returns:
    
    The distinct filtered FastStream.
  - groupBy
```
default <K> FastStream<FastStream.Group<K,T>> groupBy(java.util.function.Function<? super T,? extends K> keyFunc)
```
    Returns a FastStream containing all elements grouped by a key. The provided Function is used to extract the key from the element.
    
    Parameters:
    
    keyFunc - The key Function.
    
    Returns:
    
    The Grouped FastStream
  - groupBy
```
default <K,V> FastStream<FastStream.Group<K,V>> groupBy(java.util.function.Function<? super T,? extends K> keyFunc,
                                                        java.util.function.Function<? super T,? extends V> valueFunc)
```
    Returns a FastStream containing all elements grouped by a key. The provided Function is used to extract the key from the element.
    
    Parameters:
    
    keyFunc - The key Function.
    
    valueFunc - The value Function.
    
    Returns:
    
    The Grouped FastStream
  - partition
```
default FastStream<FastStream<T>> partition(int amount)
```
    Returns a FastStream partitioned into buckets of a specific size.
    
    Parameters:
    
    amount - The amount to store in each bucket.
    
    Returns:
    
    The partitioned FastStream
  - sorted
```
default FastStream<T> sorted()
```
    Returns a FastStream sorted based on the elements natural sort order.
    This requires that T implements Comparable.
    
    Returns:
    
    The sorted FastStream.
  - sorted
```
default FastStream<T> sorted(java.util.Comparator<? super T> comparator)
```
    Returns a FastStream sorted based on the provided comparator.
    
    Parameters:
    
    comparator - The Comparator to apply.
    
    Returns:
    
    The sorted FastStream.
  - reversed
```
default FastStream<T> reversed()
```
    Returns a FastStream in reverse order.
    
    Returns:
    
    The reversed FastStream.
  - peek
```
default FastStream<T> peek(java.util.function.Consumer<? super T> cons)
```
    Returns a FastStream which listens to all the elements which pass to the next operation.
    
    Parameters:
    
    cons - The listener Consumer.
    
    Returns:
    
    The FastStream.
  - limit
```
default FastStream<T> limit(@Range(from=-1L,to=2147483647L) int max)
```
    Returns a FastStream which will let at most max elements pass.
    A special case of -1 is provided to indicate no max limit.
    
    Parameters:
    
    max - The maximum amount of elements to pass through, or -1.
    
    Returns:
    
    The limited FastStream.
  - skip
```
default FastStream<T> skip(@Range(from=0L,to=2147483647L) int n)
```
    Returns a FastStream which will skip n number of elements.
    
    Parameters:
    
    n - The number of elements to skip.
    
    Returns:
    
    The skipping FastStream.
  - anyMatch
```
default boolean anyMatch(java.util.function.Predicate<? super T> pred)
```
    Tests if any element in the FastStream matches the provided Predicate.
    
    Parameters:
    
    pred - The Predicate to apply.
    
    Returns:
    
    If any element matches the Predicate.
  - allMatch
```
default boolean allMatch(java.util.function.Predicate<? super T> pred)
```
    Tests if all elements in the FastStream match the provided Predicate.
    
    Parameters:
    
    pred - The Predicate to apply.
    
    Returns:
    
    If all elements match the Predicate.
  - noneMatch
```
default boolean noneMatch(java.util.function.Predicate<? super T> pred)
```
    Tests if no elements in the FastStream match the provided Predicate.
    
    Parameters:
    
    pred - The Predicate to apply.
    
    Returns:
    
    If no elements match the Predicate.
  - isEmpty
```
default boolean isEmpty()
```
    Tests if the stream is empty.
    This method is provided for convenience. Generally, using knownLength() or a collecting operation would achieve greater performance.
    
    Returns:
    
    If the stream is empty.
  - knownLength
```
default int knownLength()
```
    Returns the known length for the stream.
    This may return -1 if the stream contains operations that can't know their length before computing (filter operations).
    
    Returns:
    
    The known length, or -1
  - knownLength
```
default int knownLength(boolean consumeToCalculate)
```
    Returns the known length for the stream.
    If true is specified to consumeToCalculate causes operations which would not normally know their length prior to a terminal operation being applied, to cache their result under the assumption that the stream is about to be fully consumed.
    
    Parameters:
    
    consumeToCalculate - If the caller intends to consume the entire stream via Iterable.forEach(java.util.function.Consumer<? super T>) after calling.
    
    Returns:
    
    The known length for the stream. {code -1} if the length is not known.
  - count
```
default int count()
```
    Evaluates the stream, counting the number of elements contained within.
    
    Returns:
    
    The number of elements in the stream.
  - fold
```
@Nullable
 @Contract(value="!null,_ -> !null")
default <U> U fold(@Nullable
                                                                  U identity,
                                                                  java.util.function.BiFunction<? super U,? super T,? extends U> accumulator)
```
    Returns the result of a folding operation applied to the FastStream contents.
    
    Parameters:
    
    identity - The initial value.
    
    accumulator - The Function responsible for merging elements in the stream together.
    
    Returns:
    
    The result of the fold operation. May be null if identity is null and the stream is empty.
  - fold
```
default java.util.Optional<T> fold(java.util.function.BinaryOperator<T> accumulator)
```
    Returns the result of a folding operation applied to the FastStream contents.
    
    Parameters:
    
    accumulator - The Function responsible for merging elements in the stream together.
    
    Returns:
    
    Optionally, the result of the fold operation. Will be empty if the FastStream contained no elements.
  - intSum
```
default int intSum(java.util.function.ToIntFunction<? super T> func)
```
    Sum all elements in the stream to an integer, using the provided ToIntFunction to convert each element to an integer.
    
    Parameters:
    
    func - The ToIntFunction to apply.
    
    Returns:
    
    The sum of the elements.
  - longSum
```
default long longSum(java.util.function.ToLongFunction<? super T> func)
```
    Sum all elements in the stream to a long, using the provided ToLongFunction to convert each element to a long.
    
    Parameters:
    
    func - The ToLongFunction to apply.
    
    Returns:
    
    The sum of the elements.
  - doubleSum
```
default double doubleSum(java.util.function.ToDoubleFunction<? super T> func)
```
    Sum all elements in the stream to a double, using the provided ToDoubleFunction to convert each element to a double.
    
    Parameters:
    
    func - The ToDoubleFunction to apply.
    
    Returns:
    
    The sum of the elements.
  - findFirst
```
default java.util.Optional<T> findFirst()
```
    Returns:
    
    Optionally, the first element in the stream.
  - first
```
default T first()
```
    Returns:
    
    The first element in the stream.
  - firstOrDefault
```
@Nullable
default T firstOrDefault()
```
    Returns:
    
    The first element in the stream, or null.
  - firstOrDefault
```
@Nullable
 @Contract(value="!null -> !null")
default T firstOrDefault(@Nullable
                                                                      T _default)
```
    Parameters:
    
    _default - The default value to return if the stream is empty.
    
    Returns:
    
    The first element in the stream, or _default.
  - findLast
```
default java.util.Optional<T> findLast()
```
    Returns:
    
    Optionally, the last element in the stream.
  - last
```
default T last()
```
    Returns:
    
    The last element in the stream.
  - lastOrDefault
```
@Nullable
default T lastOrDefault()
```
    Returns:
    
    The last element in the stream, or null.
  - lastOrDefault
```
@Nullable
 @Contract(value="!null -> !null")
default T lastOrDefault(@Nullable
                                                                     T _default)
```
    Parameters:
    
    _default - The default value to return if the stream is empty.
    
    Returns:
    
    The last element in the stream, or _default.
  - only
```
default T only()
```
    Returns:
    
    Returns the only element in the stream.
  - onlyOrDefault
```
@Nullable
default T onlyOrDefault()
```
    Returns:
    
    Returns the only element in the steam. null if the stream is empty or contains more than one element.
  - onlyOrDefault
```
@Nullable
 @Contract(value="!null->!null")
default T onlyOrDefault(@Nullable
                                                                   T _default)
```
    Parameters:
    
    _default - The default value to return if the stream is empty or contains more than one element.
    
    Returns:
    
    Returns the only element in the stream. _default if the stream is empty or contains more than one element.
  - minBy
```
default T minBy(java.util.function.ToIntFunction<T> func)
```
    Returns the element in the stream with the lowest value returned by the provided ToIntFunction.
    
    Parameters:
    
    func - The ToIntFunction.
    
    Returns:
    
    The minimum value.
  - minByOrDefault
```
@Nullable
default T minByOrDefault(java.util.function.ToIntFunction<T> func)
```
    Returns the element in the stream with the lowest value returned by the provided ToIntFunction.
    
    Parameters:
    
    func - The ToIntFunction.
    
    Returns:
    
    The minimum value or null if the stream is empty.
  - minByOrDefault
```
@Nullable
 @Contract(value="_,!null->!null")
default T minByOrDefault(java.util.function.ToIntFunction<T> func,
                                                                      @Nullable
                                                                      T _default)
```
    Returns the element in the stream with the lowest value returned by the provided ToIntFunction.
    
    Parameters:
    
    func - The ToIntFunction.
    
    _default - The default value to return if the stream is empty.
    
    Returns:
    
    The minimum value or _default if the stream is empty.
  - maxBy
```
default T maxBy(java.util.function.ToIntFunction<T> func)
```
    Returns the element in the stream with the highest value returned by the provided ToIntFunction.
    
    Parameters:
    
    func - The ToIntFunction.
    
    Returns:
    
    The maximum value.
  - maxByOrDefault
```
@Nullable
default T maxByOrDefault(java.util.function.ToIntFunction<T> func)
```
    Returns the element in the stream with the highest value returned by the provided ToIntFunction.
    
    Parameters:
    
    func - The ToIntFunction.
    
    Returns:
    
    The maximum value or null if the stream is empty.
  - maxByOrDefault
```
@Nullable
 @Contract(value="_,!null->!null")
default T maxByOrDefault(java.util.function.ToIntFunction<T> func,
                                                                      @Nullable
                                                                      T _default)
```
    Returns the element in the stream with the highest value returned by the provided ToIntFunction.
    
    Parameters:
    
    func - The ToIntFunction.
    
    _default - The default value to return if the stream is empty.
    
    Returns:
    
    The maximum value or _default if the stream is empty.
  - minByLong
```
default T minByLong(java.util.function.ToLongFunction<T> func)
```
    Returns the element in the stream with the lowest value returned by the provided ToLongFunction.
    
    Parameters:
    
    func - The ToLongFunction.
    
    Returns:
    
    The minimum value.
  - minByLongOrDefault
```
@Nullable
default T minByLongOrDefault(java.util.function.ToLongFunction<T> func)
```
    Returns the element in the stream with the lowest value returned by the provided ToLongFunction.
    
    Parameters:
    
    func - The ToLongFunction.
    
    Returns:
    
    The minimum value or null if the stream is empty.
  - minByLongOrDefault
```
@Nullable
 @Contract(value="_,!null->!null")
default T minByLongOrDefault(java.util.function.ToLongFunction<T> func,
                                                                          @Nullable
                                                                          T _default)
```
    Returns the element in the stream with the lowest value returned by the provided ToLongFunction.
    
    Parameters:
    
    func - The ToLongFunction.
    
    _default - The default value to return if the stream is empty.
    
    Returns:
    
    The minimum value or _default if the stream is empty.
  - maxByLong
```
default T maxByLong(java.util.function.ToLongFunction<T> func)
```
    Returns the element in the stream with the highest value returned by the provided ToLongFunction.
    
    Parameters:
    
    func - The ToLongFunction.
    
    Returns:
    
    The maximum value.
  - maxByLongOrDefault
```
@Nullable
default T maxByLongOrDefault(java.util.function.ToLongFunction<T> func)
```
    Returns the element in the stream with the highest value returned by the provided ToLongFunction.
    
    Parameters:
    
    func - The ToLongFunction.
    
    Returns:
    
    The maximum value or null if the stream is empty.
  - maxByLongOrDefault
```
@Nullable
 @Contract(value="_,!null->!null")
default T maxByLongOrDefault(java.util.function.ToLongFunction<T> func,
                                                                          @Nullable
                                                                          T _default)
```
    Returns the element in the stream with the highest value returned by the provided ToLongFunction.
    
    Parameters:
    
    func - The ToLongFunction.
    
    _default - The default value to return if the stream is empty.
    
    Returns:
    
    The maximum value or _default if the stream is empty.
  - minByDouble
```
default T minByDouble(java.util.function.ToDoubleFunction<T> func)
```
    Returns the element in the stream with the lowest value returned by the provided ToDoubleFunction.
    
    Parameters:
    
    func - The ToDoubleFunction.
    
    Returns:
    
    The minimum value.
  - minByDoubleOrDefault
```
@Nullable
default T minByDoubleOrDefault(java.util.function.ToDoubleFunction<T> func)
```
    Returns the element in the stream with the lowest value returned by the provided ToDoubleFunction.
    
    Parameters:
    
    func - The ToDoubleFunction.
    
    Returns:
    
    The minimum value or null if the stream is empty.
  - minByDoubleOrDefault
```
@Nullable
 @Contract(value="_,!null->!null")
default T minByDoubleOrDefault(java.util.function.ToDoubleFunction<T> func,
                                                                            @Nullable
                                                                            T _default)
```
    Returns the element in the stream with the lowest value returned by the provided ToDoubleFunction.
    
    Parameters:
    
    func - The ToDoubleFunction.
    
    _default - The default value to return if the stream is empty.
    
    Returns:
    
    The minimum value or _default if the stream is empty.
  - maxByDouble
```
default T maxByDouble(java.util.function.ToDoubleFunction<T> func)
```
    Returns the element in the stream with the highest value returned by the provided ToDoubleFunction.
    
    Parameters:
    
    func - The ToDoubleFunction.
    
    Returns:
    
    The maximum value.
  - maxByDoubleOrDefault
```
@Nullable
default T maxByDoubleOrDefault(java.util.function.ToDoubleFunction<T> func)
```
    Returns the element in the stream with the highest value returned by the provided ToDoubleFunction.
    
    Parameters:
    
    func - The ToDoubleFunction.
    
    Returns:
    
    The maximum value or null if the stream is empty.
  - maxByDoubleOrDefault
```
@Nullable
 @Contract(value="_,!null->!null")
default T maxByDoubleOrDefault(java.util.function.ToDoubleFunction<T> func,
                                                                            @Nullable
                                                                            T _default)
```
    Returns the element in the stream with the highest value returned by the provided ToDoubleFunction.
    
    Parameters:
    
    func - The ToDoubleFunction.
    
    _default - The default value to return if the stream is empty.
    
    Returns:
    
    The maximum value or _default if the stream is empty.
  - toList
```
default java.util.ArrayList<T> toList()
```
    Collects this stream into an ArrayList.
    
    Returns:
    
    The ArrayList.
  - toList
```
default <R> java.util.List<R> toList(FastStream.TypeCheck<R,? super T> check)
```
    Collects this stream into an ArrayList.
    
    Parameters:
    
    check - Call infer() in this argument for flexible return inference.
    
    Returns:
    
    The ArrayList.
  - toLinkedList
```
default java.util.LinkedList<T> toLinkedList()
```
    Collects this stream into a LinkedList.
    
    Returns:
    
    The LinkedList.
  - toLinkedList
```
default <R> java.util.LinkedList<R> toLinkedList(FastStream.TypeCheck<R,? super T> check)
```
    Collects this stream into a LinkedList.
    
    Parameters:
    
    check - Call infer() in this argument for flexible return inference.
    
    Returns:
    
    The LinkedList.
  - toImmutableList
```
default com.google.common.collect.ImmutableList<T> toImmutableList()
```
    Collects this stream into a ImmutableList.
    
    Returns:
    
    The ImmutableList.
  - toImmutableList
```
default <R> com.google.common.collect.ImmutableList<R> toImmutableList(FastStream.TypeCheck<R,? super T> check)
```
    Collects this stream into a ImmutableList.
    
    Parameters:
    
    check - Call infer() in this argument for flexible return inference.
    
    Returns:
    
    The ImmutableList.
  - toSet
```
default java.util.HashSet<T> toSet()
```
    Collects this stream into a HashSet.
    
    Returns:
    
    The HashSet.
  - toSet
```
default <R> java.util.HashSet<R> toSet(FastStream.TypeCheck<R,? super T> check)
```
    Collects this stream into a HashSet.
    
    Parameters:
    
    check - Call infer() in this argument for flexible return inference.
    
    Returns:
    
    The HashSet.
  - toLinkedHashSet
```
default java.util.LinkedHashSet<T> toLinkedHashSet()
```
    Collects this stream into a LinkedHashSet.
    
    Returns:
    
    The LinkedHashSet.
  - toLinkedHashSet
```
default <R> java.util.LinkedHashSet<R> toLinkedHashSet(FastStream.TypeCheck<R,? super T> check)
```
    Collects this stream into a LinkedHashSet.
    
    Parameters:
    
    check - Call infer() in this argument for flexible return inference.
    
    Returns:
    
    The LinkedHashSet.
  - toImmutableSet
```
default com.google.common.collect.ImmutableSet<T> toImmutableSet()
```
    Collects this stream into a ImmutableSet.
    
    Returns:
    
    The ImmutableSet.
  - toImmutableSet
```
default <R> com.google.common.collect.ImmutableSet<R> toImmutableSet(FastStream.TypeCheck<R,? super T> check)
```
    Collects this stream into a ImmutableSet.
    
    Parameters:
    
    check - Call infer() in this argument for flexible return inference.
    
    Returns:
    
    The ImmutableSet.
  - toArray
```
default java.lang.Object[] toArray()
```
    Collects this stream into an Object[].
    
    Returns:
    
    The Object[].
  - toArray
```
default T[] toArray(T[] arr)
```
    Collects the stream into a T[].
    
    Parameters:
    
    arr - The template array to use. If the array is large enough to fit all elements in the stream, this will be used with a single null element after the last element.
    
    Returns:
    
    The T[].
  - toArray
```
default T[] toArray(java.util.function.IntFunction<T[]> func)
```
    Collects the stream into a T[].
    In most cases, implementations of this function only query the supplied function with a size of 0 to inspect the array type, this mirrors how base Java collections implement this function. Some FastStream implementations may choose to call the supplied function with an exact size. The supplied function is expected to honor this request and return a correctly sized array.
    
    Parameters:
    
    func - The function to construct a new array instance of the desired type and length.
    
    Returns:
    
    An array of elements.
  - toMap
```
default <K,V> java.util.HashMap<K,V> toMap(java.util.function.Function<? super T,? extends K> kFunc,
                                           java.util.function.Function<? super T,? extends V> vFunc)
```
    Collects this stream into a HashMap.
    In the event of a collision, the first value will be used.
    
    Parameters:
    
    kFunc - The Function to extracting the key.
    
    vFunc - The Function to extracting the value.
    
    Returns:
    
    The HashMap.
  - toMap
```
default <K,V> java.util.HashMap<K,V> toMap(java.util.function.Function<? super T,? extends K> kFunc,
                                           java.util.function.Function<? super T,? extends V> vFunc,
                                           java.util.function.BinaryOperator<V> mergeFunc)
```
    Collects this stream into a HashMap.
    
    Parameters:
    
    kFunc - The Function to extracting the key.
    
    vFunc - The Function to extracting the value.
    
    mergeFunc - The BinaryOperator to resolve merge conflicts.
    
    Returns:
    
    The HashMap.
  - toLinkedHashMap
```
default <K,V> java.util.LinkedHashMap<K,V> toLinkedHashMap(java.util.function.Function<? super T,? extends K> kFunc,
                                                           java.util.function.Function<? super T,? extends V> vFunc)
```
    Collects this stream into a LinkedHashMap.
    In the event of a collision, the first value will be used.
    
    Parameters:
    
    kFunc - The Function to extracting the key.
    
    vFunc - The Function to extracting the value.
    
    Returns:
    
    The LinkedHashMap.
  - toLinkedHashMap
```
default <K,V> java.util.LinkedHashMap<K,V> toLinkedHashMap(java.util.function.Function<? super T,? extends K> kFunc,
                                                           java.util.function.Function<? super T,? extends V> vFunc,
                                                           java.util.function.BinaryOperator<V> mergeFunc)
```
    Collects this stream into a LinkedHashMap.
    
    Parameters:
    
    kFunc - The Function to extracting the key.
    
    vFunc - The Function to extracting the value.
    
    mergeFunc - The BinaryOperator to resolve merge conflicts.
    
    Returns:
    
    The LinkedHashMap.
  - toImmutableMap
```
default <K,V> com.google.common.collect.ImmutableMap<K,V> toImmutableMap(java.util.function.Function<? super T,? extends K> kFunc,
                                                                         java.util.function.Function<? super T,? extends V> vFunc)
```
    Collects this stream into an ImmutableMap.
    In the event of a collision, the first value will be used.
    
    Parameters:
    
    kFunc - The Function to extracting the key.
    
    vFunc - The Function to extracting the value.
    
    Returns:
    
    The ImmutableMap.
  - toImmutableMap
```
default <K,V> com.google.common.collect.ImmutableMap<K,V> toImmutableMap(java.util.function.Function<? super T,? extends K> kFunc,
                                                                         java.util.function.Function<? super T,? extends V> vFunc,
                                                                         java.util.function.BinaryOperator<V> mergeFunc)
```
    Collects this stream into an ImmutableMap.
    
    Parameters:
    
    kFunc - The Function to extracting the key.
    
    vFunc - The Function to extracting the value.
    
    mergeFunc - The BinaryOperator to resolve merge conflicts.
    
    Returns:
    
    The ImmutableMap.
  - toMap
```
default <K,V,M extends java.util.Map<K,V>> M toMap(M map,
                                                   java.util.function.Function<? super T,? extends K> kFunc,
                                                   java.util.function.Function<? super T,? extends V> vFunc)
```
    Collects this stream into the provided Map.
    In the event of a collision, the first value will be used.
    
    Parameters:
    
    kFunc - The Function to extracting the key.
    
    vFunc - The Function to extracting the value.
    
    Returns:
    
    The Map.
  - toMap
```
default <K,V,M extends java.util.Map<K,V>> M toMap(M map,
                                                   java.util.function.Function<? super T,? extends K> kFunc,
                                                   java.util.function.Function<? super T,? extends V> vFunc,
                                                   java.util.function.BinaryOperator<V> mergeFunc)
```
    Collects this stream into the provided Map.
    
    Parameters:
    
    kFunc - The Function to extracting the key.
    
    vFunc - The Function to extracting the value.
    
    mergeFunc - The BinaryOperator to resolve merge conflicts.
    
    Returns:
    
    The Map.
  - join
```
default java.lang.String join(java.lang.String sep)
```
    Join all elements of this stream together into a String, separated by sep.
    This function will use the element's Object.toString().
    
    Parameters:
    
    sep - The seperator.
    
    Returns:
    
    The joined String.
  - infer
```
static <T> FastStream.TypeCheck<T,T> infer()
```
    Used to nudge Javac to perform looser inference on return types of some collecting functions provided in here.

Interface FastStream<T>

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Field Detail

EMPTY

Method Detail

empty

of

of

of

of

of

ofNullable

of

of

concat

concatMany

concat

filter

filterNot

map

flatMap

distinct

groupBy

groupBy

partition

sorted

sorted

reversed

peek

limit

skip

anyMatch

allMatch

noneMatch

isEmpty

knownLength

knownLength

count

fold

fold

intSum

longSum

doubleSum

findFirst

first

firstOrDefault

firstOrDefault

findLast

last

lastOrDefault

lastOrDefault

only

onlyOrDefault

onlyOrDefault

minBy

minByOrDefault

minByOrDefault

maxBy

maxByOrDefault

maxByOrDefault

minByLong

minByLongOrDefault

minByLongOrDefault

maxByLong

maxByLongOrDefault

maxByLongOrDefault

minByDouble

minByDoubleOrDefault

minByDoubleOrDefault

maxByDouble

maxByDoubleOrDefault

maxByDoubleOrDefault

toList

toList

toLinkedList

toLinkedList

toImmutableList