ShortIterable (Primitive-Collections 0.8.0 API)

All Superinterfaces:

java.lang.Iterable<java.lang.Short>

All Known Subinterfaces:

ShortCollection, ShortList, ShortNavigableSet, ShortOrderedSet, ShortPriorityDequeue, ShortPriorityQueue, ShortSet, ShortSortedSet

All Known Implementing Classes:

AbstractShortCollection, AbstractShortList, AbstractShortPriorityQueue, AbstractShortSet, CopyOnWriteShortArrayList, ImmutableShortList, ImmutableShortOpenHashSet, ShortArrayFIFOQueue, ShortArrayList, ShortArrayPriorityQueue, ShortArraySet, ShortAVLTreeSet, ShortCollections.EmptyCollection, ShortCollections.SynchronizedCollection, ShortCollections.UnmodifiableCollection, ShortHeapPriorityQueue, ShortLinkedList, ShortLinkedOpenCustomHashSet, ShortLinkedOpenHashSet, ShortOpenCustomHashSet, ShortOpenHashSet, ShortPriorityQueues.SynchronizedPriorityDequeue, ShortPriorityQueues.SynchronizedPriorityQueue, ShortRBTreeSet, ShortSets.UnmodifiableSet
```
public interface ShortIterable
extends java.lang.Iterable<java.lang.Short>
```
A Type-Specific Iterable that reduces (un)boxing

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default <E> ObjectIterable<E>`	`arrayflatMap(ShortFunction<E[]> mapper)` A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
`default ShortAsyncBuilder`	`asAsync()` Creates a Async Builder for moving work of the thread.
`default int`	`count(ShortPredicate filter)` Helper function to reduce stream usage that allows to count the valid elements.
`default ShortIterable`	`distinct()` A Helper function to reduce the usage of Streams and allows to filter out duplicated elements
`default ShortIterable`	`filter(ShortPredicate filter)` A Helper function to reduce the usage of Streams and allows to filter out unwanted elements
`default short`	`findFirst(ShortPredicate filter)` Helper function to reduce stream usage that allows to filter for the first match.
`default <E,V extends java.lang.Iterable<E>> ObjectIterable<E>`	`flatMap(ShortFunction<V> mapper)` A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
`default void`	`forEach(java.util.function.Consumer<? super java.lang.Short> action)` Deprecated. Please use the corresponding type-specific function instead.
`default <E> void`	`forEach(E input, ObjectShortConsumer<E> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`default void`	`forEach(ShortConsumer action)` A Type Specific foreach function that reduces (un)boxing
`default void`	`forEachIndexed(IntShortConsumer action)` A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
`ShortIterator`	`iterator()` Returns an iterator over elements of type `T`.
`default ShortIterable`	`limit(long limit)` A Helper function to reduce the usage of Streams and allows to limit the amount of elements
`default <E> ObjectIterable<E>`	`map(ShortFunction<E> mapper)` A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
`default boolean`	`matchesAll(ShortPredicate filter)` Helper function to reduce stream usage that allows to filter for all matches.
`default boolean`	`matchesAny(ShortPredicate filter)` Helper function to reduce stream usage that allows to filter for any matches.
`default boolean`	`matchesNone(ShortPredicate filter)` Helper function to reduce stream usage that allows to filter for no matches.
`default ShortIterable`	`peek(ShortConsumer action)` A Helper function to reduce the usage of Streams and allows to preview elements before they are iterated through
`default <E extends ShortCollection> E`	`pour(E collection)` A Helper function to reduce the usage of Streams and allows to collect all elements
`default ShortList`	`pourAsList()` A Helper function that reduces the usage of streams and allows to collect all elements as a ArrayList
`default ShortSet`	`pourAsSet()` A Helper function that reduces the usage of streams and allows to collect all elements as a LinkedHashSet
`default short`	`reduce(short identity, ShortShortUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`default short`	`reduce(ShortShortUnaryOperator operator)` Performs a reduction on the elements of this Iterable
`default ShortIterable`	`repeat(int repeats)` A Helper function to reduce the usage of Streams and allows to repeat elements a desired amount of times
`default ShortIterable`	`sorted(ShortComparator sorter)` A Helper function to reduce the usage of Streams and allows to sort the elements
`default ShortSplititerator`	`spliterator()` A Type Specific Type Splititerator to reduce boxing/unboxing
`default short[]`	`toShortArray()` A Helper function that reduces the usage of streams and allows to collect all elements as a Array

- Method Detail
  - iterator
```
ShortIterator iterator()
```
    Returns an iterator over elements of type T.
    
    Specified by:
    
    iterator in interface java.lang.Iterable<java.lang.Short>
    
    Returns:
    
    an Iterator.
  - forEach
```
default void forEach(ShortConsumer action)
```
    A Type Specific foreach function that reduces (un)boxing
    Parameters:
    
    action - The action to be performed for each element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
    
    See Also:
    
    Iterable.forEach(Consumer)
    
    ImplSpec:
    The default implementation behaves as if:
    iterator().forEachRemaining(action);
  - forEach
```
@Deprecated
default void forEach(java.util.function.Consumer<? super java.lang.Short> action)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    forEach in interface java.lang.Iterable<java.lang.Short>
  - forEachIndexed
```
default void forEachIndexed(IntShortConsumer action)
```
    A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
    
    Parameters:
    
    action - The action to be performed for each element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
  - forEach
```
default <E> void forEach(E input,
                         ObjectShortConsumer<E> action)
```
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Type Parameters:
    
    E - the generic type of the Object
    
    Parameters:
    
    input - the object that should be included
    
    action - The action to be performed for each element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
  - spliterator
```
default ShortSplititerator spliterator()
```
    A Type Specific Type Splititerator to reduce boxing/unboxing
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<java.lang.Short>
    
    Returns:
    
    type specific splititerator
  - asAsync
```
default ShortAsyncBuilder asAsync()
```
    Creates a Async Builder for moving work of the thread. It is not designed to split the work to multithreaded work, so using this keep it singlethreaded, but it allows to be moved to another thread.
    
    Returns:
    
    a AsyncBuilder
    
    See Also:
    
    ShortAsyncBuilder
  - map
```
default <E> ObjectIterable<E> map(ShortFunction<E> mapper)
```
    A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    mapper - the mapping function
    
    Returns:
    
    a new Iterable that returns the desired result
  - flatMap
```
default <E,V extends java.lang.Iterable<E>> ObjectIterable<E> flatMap(ShortFunction<V> mapper)
```
    A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
    
    Type Parameters:
    
    V - The return type supplier.
    
    E - The return type.
    
    Parameters:
    
    mapper - the flatMapping function
    
    Returns:
    
    a new Iterable that returns the desired result
    
    Note:
    
    does not support toShortArray optimizations.
  - arrayflatMap
```
default <E> ObjectIterable<E> arrayflatMap(ShortFunction<E[]> mapper)
```
    A Helper function to reduce the usage of Streams and allows to convert a Iterable to something else.
    
    Type Parameters:
    
    E - The return type.
    
    Parameters:
    
    mapper - the flatMapping function
    
    Returns:
    
    a new Iterable that returns the desired result
    
    Note:
    
    does not support toShortArray optimizations.
  - filter
```
default ShortIterable filter(ShortPredicate filter)
```
    A Helper function to reduce the usage of Streams and allows to filter out unwanted elements
    
    Parameters:
    
    filter - the elements that should be kept.
    
    Returns:
    
    a Iterable that filtered out all unwanted elements
    
    Note:
    
    does not support toShortArray optimizations.
  - distinct
```
default ShortIterable distinct()
```
    A Helper function to reduce the usage of Streams and allows to filter out duplicated elements
    
    Returns:
    
    a Iterable that filtered out all duplicated elements
    
    Note:
    
    does not support toShortArray optimizations.
  - repeat
```
default ShortIterable repeat(int repeats)
```
    A Helper function to reduce the usage of Streams and allows to repeat elements a desired amount of times
    
    Parameters:
    
    repeats - how many times the elements should be repeated
    
    Returns:
    
    a Iterable that is repeating multiple times
  - limit
```
default ShortIterable limit(long limit)
```
    A Helper function to reduce the usage of Streams and allows to limit the amount of elements
    
    Parameters:
    
    limit - the amount of elements it should be limited to
    
    Returns:
    
    a Iterable that is limited in length
  - sorted
```
default ShortIterable sorted(ShortComparator sorter)
```
    A Helper function to reduce the usage of Streams and allows to sort the elements
    
    Parameters:
    
    sorter - that sorts the elements.
    
    Returns:
    
    a Iterable that is sorted
  - peek
```
default ShortIterable peek(ShortConsumer action)
```
    A Helper function to reduce the usage of Streams and allows to preview elements before they are iterated through
    
    Parameters:
    
    action - the action that should be applied
    
    Returns:
    
    a Peeked Iterable
  - pour
```
default <E extends ShortCollection> E pour(E collection)
```
    A Helper function to reduce the usage of Streams and allows to collect all elements
    
    Type Parameters:
    
    E - the collection type
    
    Parameters:
    
    collection - that the elements should be inserted to
    
    Returns:
    
    the input with the desired elements
  - pourAsList
```
default ShortList pourAsList()
```
    A Helper function that reduces the usage of streams and allows to collect all elements as a ArrayList
    
    Returns:
    
    a new ArrayList of all elements
  - pourAsSet
```
default ShortSet pourAsSet()
```
    A Helper function that reduces the usage of streams and allows to collect all elements as a LinkedHashSet
    
    Returns:
    
    a new LinkedHashSet of all elements
  - toShortArray
```
default short[] toShortArray()
```
    A Helper function that reduces the usage of streams and allows to collect all elements as a Array
    
    Returns:
    
    a new Array of all elements
  - matchesAny
```
default boolean matchesAny(ShortPredicate filter)
```
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
default boolean matchesNone(ShortPredicate filter)
```
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
default boolean matchesAll(ShortPredicate filter)
```
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - findFirst
```
default short findFirst(ShortPredicate filter)
```
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - reduce
```
default short reduce(short identity,
                     ShortShortUnaryOperator operator)
```
    Performs a reduction on the elements of this Iterable
    
    Parameters:
    
    operator - the operation that should be applied
    
    identity - the start value
    
    Returns:
    
    the reduction result, returns identity if nothing was found
  - reduce
```
default short reduce(ShortShortUnaryOperator operator)
```
    Performs a reduction on the elements of this Iterable
    
    Parameters:
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns null value if nothing was found
  - count
```
default int count(ShortPredicate filter)
```
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements

Interface ShortIterable

Method Summary

Method Detail

iterator

forEach

forEach

forEachIndexed

forEach

spliterator

asAsync

map

flatMap

arrayflatMap

filter

distinct

repeat

limit

sorted

peek

pour

pourAsList

pourAsSet

toShortArray

matchesAny

matchesNone

matchesAll

findFirst

reduce

reduce

count