ShortIterable (Eclipse Collections

All Superinterfaces:

PrimitiveIterable

All Known Subinterfaces:

ByteShortMap, CharShortMap, DoubleShortMap, FloatShortMap, ImmutableByteShortMap, ImmutableCharShortMap, ImmutableDoubleShortMap, ImmutableFloatShortMap, ImmutableIntShortMap, ImmutableLongShortMap, ImmutableObjectShortMap<K>, ImmutableShortBag, ImmutableShortCollection, ImmutableShortList, ImmutableShortSet, ImmutableShortShortMap, ImmutableShortStack, IntShortMap, LazyShortIterable, LongShortMap, MutableByteShortMap, MutableCharShortMap, MutableDoubleShortMap, MutableFloatShortMap, MutableIntShortMap, MutableLongShortMap, MutableObjectShortMap<K>, MutableShortBag, MutableShortCollection, MutableShortList, MutableShortSet, MutableShortShortMap, MutableShortStack, MutableShortValuesMap, ObjectShortMap<K>, OrderedShortIterable, ReversibleShortIterable, ShortBag, ShortList, ShortSet, ShortShortMap, ShortStack, ShortValuesMap

All Known Implementing Classes:

AbstractImmutableObjectShortMap, AbstractImmutableShortSet, AbstractLazyShortIterable, AbstractMutableShortKeySet, AbstractMutableShortValuesMap, AbstractShortIterable, AbstractShortSet, AbstractShortStack, AbstractSynchronizedShortCollection, AbstractUnmodifiableShortCollection, ByteShortHashMap, CharShortHashMap, CollectBooleanToShortIterable, CollectByteToShortIterable, CollectCharToShortIterable, CollectDoubleToShortIterable, CollectFloatToShortIterable, CollectIntToShortIterable, CollectLongToShortIterable, CollectShortIterable, CollectShortToShortIterable, DoubleShortHashMap, FloatShortHashMap, IntShortHashMap, LazyShortIterableAdapter, LongShortHashMap, ObjectShortHashMap, ObjectShortHashMapWithHashingStrategy, ReverseShortIterable, SelectShortIterable, ShortArrayList, ShortArrayStack, ShortHashBag, ShortHashSet, ShortShortHashMap, SynchronizedByteShortMap, SynchronizedCharShortMap, SynchronizedDoubleShortMap, SynchronizedFloatShortMap, SynchronizedIntShortMap, SynchronizedLongShortMap, SynchronizedObjectShortMap, SynchronizedShortBag, SynchronizedShortCollection, SynchronizedShortIterable, SynchronizedShortList, SynchronizedShortSet, SynchronizedShortShortMap, SynchronizedShortStack, TapShortIterable, UnmodifiableByteShortMap, UnmodifiableCharShortMap, UnmodifiableDoubleShortMap, UnmodifiableFloatShortMap, UnmodifiableIntShortMap, UnmodifiableLongShortMap, UnmodifiableObjectShortMap, UnmodifiableShortBag, UnmodifiableShortCollection, UnmodifiableShortList, UnmodifiableShortSet, UnmodifiableShortShortMap, UnmodifiableShortStack
```
public interface ShortIterable
extends PrimitiveIterable
```
ShortIterable is an interface which is memory-optimized for short primitives. It is inspired by the interface RichIterable, and contains a subset of the internal iterator methods on RichIterable like collect, sum, etc. The API also includes an external iterator method, which returns an ShortIterator. ShortIterator helps iterate over the ShortIterable without boxing the primitives. This file was automatically generated from template file primitiveIterable.stg.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`boolean`	`allSatisfy(ShortPredicate predicate)`	Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
`boolean`	`anySatisfy(ShortPredicate predicate)`	Returns true if any of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
`LazyShortIterable`	`asLazy()`	Returns a LazyShortIterable adapter wrapping the source ShortIterable.
`double`	`average()`
`default double`	`averageIfEmpty(double defaultValue)`
`default RichIterable<ShortIterable>`	`chunk(int size)`	Partitions elements in fixed size chunks.
`<V> RichIterable<V>`	`collect(ShortToObjectFunction<? extends V> function)`	Returns a new collection with the results of applying the specified function on each element of the source collection.
`default <V,R extends java.util.Collection<V>> R`	`collect(ShortToObjectFunction<? extends V> function, R target)`	Same as `collect(ShortToObjectFunction)` , only the results are added to the target Collection.
`default <R extends MutableBooleanCollection> R`	`collectBoolean(ShortToBooleanFunction function, R target)`	Returns the target `MutableBooleanCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableByteCollection> R`	`collectByte(ShortToByteFunction function, R target)`	Returns the target `MutableByteCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableCharCollection> R`	`collectChar(ShortToCharFunction function, R target)`	Returns the target `MutableCharCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableDoubleCollection> R`	`collectDouble(ShortToDoubleFunction function, R target)`	Returns the target `MutableDoubleCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableFloatCollection> R`	`collectFloat(ShortToFloatFunction function, R target)`	Returns the target `MutableFloatCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableIntCollection> R`	`collectInt(ShortToIntFunction function, R target)`	Returns the target `MutableIntCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableLongCollection> R`	`collectLong(ShortToLongFunction function, R target)`	Returns the target `MutableLongCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableShortCollection> R`	`collectShort(ShortToShortFunction function, R target)`	Returns the target `MutableShortCollection` with the results of applying the specified function on each element of the source collection.
`boolean`	`contains(short value)`	Returns true if the value is contained in the ShortIterable, and false if it is not.
`boolean`	`containsAll(short... source)`	Returns true if the all of the values specified in the source array are contained in the ShortIterable, and false if they are not.
`boolean`	`containsAll(ShortIterable source)`	Returns true if the all of the values specified in the source ShortIterable are contained in the ShortIterable, and false if they are not.
`int`	`count(ShortPredicate predicate)`	Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.
`short`	`detectIfNone(ShortPredicate predicate, short ifNone)`
`void`	`each(ShortProcedure procedure)`	A synonym for forEach.
`default <V,R extends java.util.Collection<V>> R`	`flatCollect(ShortToObjectFunction<? extends java.lang.Iterable<V>> function, R target)`	`flatCollect` is a special case of `collect(ShortToObjectFunction)`.
`void`	`forEach(ShortProcedure procedure)`	Applies the ShortProcedure to each element in the ShortIterable.
`<T> T`	`injectInto(T injectedValue, ObjectShortToObjectFunction<? super T,? extends T> function)`
`short`	`max()`
`short`	`maxIfEmpty(short defaultValue)`
`double`	`median()`
`default double`	`medianIfEmpty(double defaultValue)`
`short`	`min()`
`short`	`minIfEmpty(short defaultValue)`
`boolean`	`noneSatisfy(ShortPredicate predicate)`	Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
`default long`	`reduce(LongShortToLongFunction accumulator)`
`default long`	`reduceIfEmpty(LongShortToLongFunction accumulator, long defaultValue)`
`ShortIterable`	`reject(ShortPredicate predicate)`	Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.
`default <R extends MutableShortCollection> R`	`reject(ShortPredicate predicate, R target)`	Same as `reject(ShortPredicate)` , only the results are added to the target MutableShortCollection.
`ShortIterable`	`select(ShortPredicate predicate)`	Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.
`default <R extends MutableShortCollection> R`	`select(ShortPredicate predicate, R target)`	Same as `select(ShortPredicate)` , only the results are added to the target MutableShortCollection.
`ShortIterator`	`shortIterator()`	Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.
`long`	`sum()`
`default java.util.IntSummaryStatistics`	`summaryStatistics()`
`default ShortIterable`	`tap(ShortProcedure procedure)`
`short[]`	`toArray()`	Converts the ShortIterable to a primitive short array.
`MutableShortBag`	`toBag()`	Converts the ShortIterable to a new MutableShortBag.
`MutableShortList`	`toList()`	Converts the ShortIterable to a new MutableShortList.
`MutableShortSet`	`toSet()`	Converts the ShortIterable to a new MutableShortSet.
`short[]`	`toSortedArray()`
`MutableShortList`	`toSortedList()`

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size, toString

- Method Detail
  - shortIterator
```
ShortIterator shortIterator()
```
    Returns a primitive iterator that can be used to iterate over the ShortIterable in an imperative style.
  - toArray
```
short[] toArray()
```
    Converts the ShortIterable to a primitive short array.
  - contains
```
boolean contains(short value)
```
    Returns true if the value is contained in the ShortIterable, and false if it is not.
  - containsAll
```
boolean containsAll(short... source)
```
    Returns true if the all of the values specified in the source array are contained in the ShortIterable, and false if they are not.
  - containsAll
```
boolean containsAll(ShortIterable source)
```
    Returns true if the all of the values specified in the source ShortIterable are contained in the ShortIterable, and false if they are not.
  - forEach
```
void forEach(ShortProcedure procedure)
```
    Applies the ShortProcedure to each element in the ShortIterable.
  - each
```
void each(ShortProcedure procedure)
```
    A synonym for forEach.
    
    Since:
    
    7.0.
  - tap
```
default ShortIterable tap(ShortProcedure procedure)
```
    Since:
    
    9.0.
  - select
```
ShortIterable select(ShortPredicate predicate)
```
    Returns a new ShortIterable with all of the elements in the ShortIterable that return true for the specified predicate.
  - reject
```
ShortIterable reject(ShortPredicate predicate)
```
    Returns a new ShortIterable with all of the elements in the ShortIterable that return false for the specified predicate.
  - select
```
default <R extends MutableShortCollection> R select(ShortPredicate predicate,
                                                    R target)
```
    Same as select(ShortPredicate) , only the results are added to the target MutableShortCollection.
    
    Since:
    
    8.1.
  - reject
```
default <R extends MutableShortCollection> R reject(ShortPredicate predicate,
                                                    R target)
```
    Same as reject(ShortPredicate) , only the results are added to the target MutableShortCollection.
    
    Since:
    
    8.1.
  - collect
```
<V> RichIterable<V> collect(ShortToObjectFunction<? extends V> function)
```
    Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
  - collect
```
default <V,R extends java.util.Collection<V>> R collect(ShortToObjectFunction<? extends V> function,
                                                        R target)
```
    Same as collect(ShortToObjectFunction) , only the results are added to the target Collection.
    
    Since:
    
    8.1.
  - flatCollect
```
default <V,R extends java.util.Collection<V>> R flatCollect(ShortToObjectFunction<? extends java.lang.Iterable<V>> function,
                                                            R target)
```
    flatCollect is a special case of collect(ShortToObjectFunction). With collect, when the ShortToObjectFunction returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.
    
    Since:
    
    8.1.
  - collectBoolean
```
default <R extends MutableBooleanCollection> R collectBoolean(ShortToBooleanFunction function,
                                                              R target)
```
    Returns the target MutableBooleanCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectByte
```
default <R extends MutableByteCollection> R collectByte(ShortToByteFunction function,
                                                        R target)
```
    Returns the target MutableByteCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectChar
```
default <R extends MutableCharCollection> R collectChar(ShortToCharFunction function,
                                                        R target)
```
    Returns the target MutableCharCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectShort
```
default <R extends MutableShortCollection> R collectShort(ShortToShortFunction function,
                                                          R target)
```
    Returns the target MutableShortCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectInt
```
default <R extends MutableIntCollection> R collectInt(ShortToIntFunction function,
                                                      R target)
```
    Returns the target MutableIntCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectFloat
```
default <R extends MutableFloatCollection> R collectFloat(ShortToFloatFunction function,
                                                          R target)
```
    Returns the target MutableFloatCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectLong
```
default <R extends MutableLongCollection> R collectLong(ShortToLongFunction function,
                                                        R target)
```
    Returns the target MutableLongCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectDouble
```
default <R extends MutableDoubleCollection> R collectDouble(ShortToDoubleFunction function,
                                                            R target)
```
    Returns the target MutableDoubleCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - detectIfNone
```
short detectIfNone(ShortPredicate predicate,
                   short ifNone)
```
  - count
```
int count(ShortPredicate predicate)
```
    Returns a count of the number of elements in the ShortIterable that return true for the specified predicate.
  - anySatisfy
```
boolean anySatisfy(ShortPredicate predicate)
```
    Returns true if any of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
  - allSatisfy
```
boolean allSatisfy(ShortPredicate predicate)
```
    Returns true if all of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
  - noneSatisfy
```
boolean noneSatisfy(ShortPredicate predicate)
```
    Returns true if none of the elements in the ShortIterable return true for the specified predicate, otherwise returns false.
  - toList
```
MutableShortList toList()
```
    Converts the ShortIterable to a new MutableShortList.
  - toSet
```
MutableShortSet toSet()
```
    Converts the ShortIterable to a new MutableShortSet.
  - toBag
```
MutableShortBag toBag()
```
    Converts the ShortIterable to a new MutableShortBag.
  - asLazy
```
LazyShortIterable asLazy()
```
    Returns a LazyShortIterable adapter wrapping the source ShortIterable.
  - injectInto
```
<T> T injectInto(T injectedValue,
                 ObjectShortToObjectFunction<? super T,? extends T> function)
```
  - reduceIfEmpty
```
default long reduceIfEmpty(LongShortToLongFunction accumulator,
                           long defaultValue)
```
    Since:
    
    10.0
    
    See Also:
    
    reduce(LongShortToLongFunction)
  - reduce
```
default long reduce(LongShortToLongFunction accumulator)
```
    Since:
    
    10.0
    
    See Also:
    
    RichIterable.reduce(BinaryOperator)
  - chunk
```
default RichIterable<ShortIterable> chunk(int size)
```
    Partitions elements in fixed size chunks.
    
    Parameters:
    
    size - the number of elements per chunk
    
    Returns:
    
    A RichIterable containing ShortIterables of size size, except the last will be truncated if the elements don't divide evenly.
    
    Since:
    
    9.2
  - sum
```
long sum()
```
  - summaryStatistics
```
default java.util.IntSummaryStatistics summaryStatistics()
```
    Since:
    
    8.0
  - max
```
short max()
```
  - maxIfEmpty
```
short maxIfEmpty(short defaultValue)
```
  - min
```
short min()
```
  - minIfEmpty
```
short minIfEmpty(short defaultValue)
```
  - average
```
double average()
```
  - averageIfEmpty
```
default double averageIfEmpty(double defaultValue)
```
    Since:
    
    9.0
  - median
```
double median()
```
  - medianIfEmpty
```
default double medianIfEmpty(double defaultValue)
```
    Since:
    
    9.0
  - toSortedArray
```
short[] toSortedArray()
```
  - toSortedList
```
MutableShortList toSortedList()
```

Interface ShortIterable

Method Summary

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable

Method Detail

shortIterator

toArray

contains

containsAll

containsAll

forEach

each

tap

select

reject

select

reject

collect

collect

flatCollect

collectBoolean

collectByte

collectChar

collectShort

collectInt

collectFloat

collectLong

collectDouble

detectIfNone

count

anySatisfy

allSatisfy

noneSatisfy

toList

toSet

toBag

asLazy

injectInto

reduceIfEmpty

reduce

chunk

sum

summaryStatistics

max

maxIfEmpty

min

minIfEmpty

average

averageIfEmpty

median

medianIfEmpty

toSortedArray

toSortedList