Eclipse Collections 13.0.0 · org.eclipse.collections.api.LongIterable

Method Summary

Modifier and Type	Method and Description
public boolean	allSatisfy(LongPredicate predicate) Returns true if all of the elements in the LongIterable return true for the specified predicate, otherwise returns false.
public boolean	anySatisfy(LongPredicate predicate) Returns true if any of the elements in the LongIterable return true for the specified predicate, otherwise returns false.
public LazyLongIterable	asLazy() Returns a LazyLongIterable adapter wrapping the source LongIterable.
public double	average()
public default double	averageIfEmpty(double defaultValue)
public default RichIterable<LongIterable>	Returns: A `RichIterable` containing `LongIterable`s of size `size`, except the last will be truncated if the elements don't divide evenly. chunk(int the number of elements per chunk size) Partitions elements in fixed size chunks.
public <V> RichIterable<V>	collect(LongToObjectFunction<? extends V> function) Returns a new collection with the results of applying the specified function on each element of the source collection.
public default <V, R extends Collection<V>> R	collect(LongToObjectFunction<? extends V> function, R target) Same as `collect(LongToObjectFunction)` , only the results are added to the target Collection.
public default <R extends MutableBooleanCollection> R	collectBoolean(LongToBooleanFunction function, R target) Returns the target `MutableBooleanCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableByteCollection> R	collectByte(LongToByteFunction function, R target) Returns the target `MutableByteCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableCharCollection> R	collectChar(LongToCharFunction function, R target) Returns the target `MutableCharCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableDoubleCollection> R	collectDouble(LongToDoubleFunction function, R target) Returns the target `MutableDoubleCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableFloatCollection> R	collectFloat(LongToFloatFunction function, R target) Returns the target `MutableFloatCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableIntCollection> R	collectInt(LongToIntFunction function, R target) Returns the target `MutableIntCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableLongCollection> R	collectLong(LongToLongFunction function, R target) Returns the target `MutableLongCollection` with the results of applying the specified function on each element of the source collection.
public default <R extends MutableShortCollection> R	collectShort(LongToShortFunction function, R target) Returns the target `MutableShortCollection` with the results of applying the specified function on each element of the source collection.
public boolean	contains(long value) Returns true if the value is contained in the LongIterable, and false if it is not.
public default boolean	containsAll(long... source) Returns true if all of the values specified in the source array are contained in the LongIterable, and false if they are not.
public default boolean	containsAll(LongIterable source) Returns true if all of the values specified in the source LongIterable are contained in the LongIterable, and false if they are not.
public default boolean	containsAny(long... source) Returns true if any of the values specified in the source array are contained in the LongIterable, and false if they are not.
public default boolean	containsAny(LongIterable source) Returns true if any of the values specified in the source LongIterable are contained in the LongIterable, and false if they are not.
public default boolean	containsNone(long... source) Returns true if none of the values specified in the source array are contained in the LongIterable, and false if they are.
public default boolean	containsNone(LongIterable source) Returns true if none of the values specified in the source LongIterable are contained in the LongIterable, and false if they are.
public int	count(LongPredicate predicate) Returns a count of the number of elements in the LongIterable that return true for the specified predicate.
public long	detectIfNone(LongPredicate predicate, long ifNone)
public void	each(LongProcedure procedure) A synonym for forEach.
public default <V, R extends Collection<V>> R	flatCollect(LongToObjectFunction<? extends Iterable<V>> function, R target) `flatCollect` is a special case of `collect(LongToObjectFunction)`.
public default void	forEach(LongProcedure procedure) Applies the LongProcedure to each element in the LongIterable.
public <T> T	injectInto(T injectedValue, ObjectLongToObjectFunction<? super T, ? extends T> function)
public default boolean	injectIntoBoolean(boolean injectedValue, BooleanLongToBooleanFunction function) Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default byte	injectIntoByte(byte injectedValue, ByteLongToByteFunction function) Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default char	injectIntoChar(char injectedValue, CharLongToCharFunction function) Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default double	injectIntoDouble(double injectedValue, DoubleLongToDoubleFunction function) Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default float	injectIntoFloat(float injectedValue, FloatLongToFloatFunction function) Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default int	injectIntoInt(int injectedValue, IntLongToIntFunction function) Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default long	injectIntoLong(long injectedValue, LongLongToLongFunction function) Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public default short	injectIntoShort(short injectedValue, ShortLongToShortFunction function) Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
public LongIterator	longIterator() Returns a primitive iterator that can be used to iterate over the LongIterable in an imperative style.
public long	max()
public long	maxIfEmpty(long defaultValue)
public double	median()
public default double	medianIfEmpty(double defaultValue)
public long	min()
public long	minIfEmpty(long defaultValue)
public default boolean	noneSatisfy(LongPredicate predicate) Returns true if none of the elements in the LongIterable return true for the specified predicate, otherwise returns false.
public default long	reduce(LongLongToLongFunction accumulator)
public default long	reduceIfEmpty(LongLongToLongFunction accumulator, long defaultValue)
public LongIterable	reject(LongPredicate predicate) Returns a new LongIterable with all of the elements in the LongIterable that return false for the specified predicate.
public default <R extends MutableLongCollection> R	reject(LongPredicate predicate, R target) Same as `reject(LongPredicate)` , only the results are added to the target MutableLongCollection.
public LongIterable	select(LongPredicate predicate) Returns a new LongIterable with all of the elements in the LongIterable that return true for the specified predicate.
public default <R extends MutableLongCollection> R	select(LongPredicate predicate, R target) Same as `select(LongPredicate)` , only the results are added to the target MutableLongCollection.
public long	sum()
public default LongSummaryStatistics	summaryStatistics()
public default LongIterable	tap(LongProcedure procedure)
public long[]	toArray() Converts the LongIterable to a primitive long array.
public default long[]	toArray(long[] target) Converts the LongIterable to a primitive long array.
public MutableLongBag	toBag() Converts the LongIterable to a new MutableLongBag.
public MutableLongList	toList() Converts the LongIterable to a new MutableLongList.
public MutableLongSet	toSet() Converts the LongIterable to a new MutableLongSet.
public long[]	toSortedArray()
public MutableLongList	toSortedList()
public default MutableLongList	toSortedList(LongComparator comparator) Converts the collection to a MutableLongList implementation sorted using the provided comparator.
public default <T> MutableLongList	toSortedListBy(LongToObjectFunction<T> function) Converts the collection to a MutableLongListImplementation sorted based on the natural order of the key returned by `function`.
public default <T> MutableLongList	toSortedListBy(LongToObjectFunction<T> function, Comparator<? super T> comparator) Converts the collection to a MutableLongList implementation, which is sorted based on the key returned by `function` using the provided `comparator`.

Inherited from org.eclipse.collections.api.PrimitiveIterable:: appendString appendString appendString isEmpty makeString makeString makeString notEmpty size toString

Method Detail

allSatisfy	back to summary
public boolean allSatisfy(LongPredicate predicate) Returns true if all of the elements in the LongIterable return true for the specified predicate, otherwise returns false.

anySatisfy	back to summary
public boolean anySatisfy(LongPredicate predicate) Returns true if any of the elements in the LongIterable return true for the specified predicate, otherwise returns false.

asLazy	back to summary
public LazyLongIterable asLazy() Returns a LazyLongIterable adapter wrapping the source LongIterable.

average	back to summary
public double average()

averageIfEmpty	back to summary
public default double averageIfEmpty(double defaultValue) Since 9.0

chunk back to summary

chunk	back to summary
public default RichIterable<LongIterable> chunk(int size) Partitions elements in fixed size chunks. Parameters size:int the number of elements per chunk Returns:RichIterable<LongIterable> A `RichIterable` containing `LongIterable`s of size `size`, except the last will be truncated if the elements don't divide evenly. Since 9.2

public default RichIterable<LongIterable> chunk(int size)

Partitions elements in fixed size chunks.

Parameters

size:int: the number of elements per chunk

Returns:RichIterable<LongIterable>

A RichIterable containing LongIterables of size size, except the last will be truncated if the elements don't divide evenly.

Since

9.2

collect	back to summary
public <V> RichIterable<V> collect(LongToObjectFunction<? 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 back to summary

collect	back to summary
public default <V, R extends Collection<V>> R collect(LongToObjectFunction<? extends V> function, R target) Same as `collect(LongToObjectFunction)` , only the results are added to the target Collection. Since 8.1.

public default <V, R extends Collection<V>> R collect(LongToObjectFunction<? extends V> function, R target)

Same as collect(LongToObjectFunction) , only the results are added to the target Collection.

Since: 8.1.

collectBoolean back to summary

collectBoolean	back to summary
public default <R extends MutableBooleanCollection> R collectBoolean(LongToBooleanFunction 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.

public default <R extends MutableBooleanCollection> R collectBoolean(LongToBooleanFunction 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 back to summary

collectByte	back to summary
public default <R extends MutableByteCollection> R collectByte(LongToByteFunction 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.

public default <R extends MutableByteCollection> R collectByte(LongToByteFunction 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 back to summary

collectChar	back to summary
public default <R extends MutableCharCollection> R collectChar(LongToCharFunction 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.

public default <R extends MutableCharCollection> R collectChar(LongToCharFunction 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.

collectDouble back to summary

collectDouble	back to summary
public default <R extends MutableDoubleCollection> R collectDouble(LongToDoubleFunction 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.

public default <R extends MutableDoubleCollection> R collectDouble(LongToDoubleFunction 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.

collectFloat back to summary

collectFloat	back to summary
public default <R extends MutableFloatCollection> R collectFloat(LongToFloatFunction 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.

public default <R extends MutableFloatCollection> R collectFloat(LongToFloatFunction 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.

collectInt back to summary

collectInt	back to summary
public default <R extends MutableIntCollection> R collectInt(LongToIntFunction 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.

public default <R extends MutableIntCollection> R collectInt(LongToIntFunction 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.

collectLong back to summary

collectLong	back to summary
public default <R extends MutableLongCollection> R collectLong(LongToLongFunction 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.

public default <R extends MutableLongCollection> R collectLong(LongToLongFunction 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.

collectShort back to summary

collectShort	back to summary
public default <R extends MutableShortCollection> R collectShort(LongToShortFunction 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.

public default <R extends MutableShortCollection> R collectShort(LongToShortFunction 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.

contains	back to summary
public boolean contains(long value) Returns true if the value is contained in the LongIterable, and false if it is not.

containsAll	back to summary
public default boolean containsAll(long... source) Returns true if all of the values specified in the source array are contained in the LongIterable, and false if they are not.

containsAll	back to summary
public default boolean containsAll(LongIterable source) Returns true if all of the values specified in the source LongIterable are contained in the LongIterable, and false if they are not.

containsAny	back to summary
public default boolean containsAny(long... source) Returns true if any of the values specified in the source array are contained in the LongIterable, and false if they are not. Since 11.0

containsAny

back to summary

public default boolean containsAny(long... source)

Returns true if any of the values specified in the source array are contained in the LongIterable, and false if they are not.

Since: 11.0

containsAny	back to summary
public default boolean containsAny(LongIterable source) Returns true if any of the values specified in the source LongIterable are contained in the LongIterable, and false if they are not. Since 11.0

containsAny

back to summary

public default boolean containsAny(LongIterable source)

Returns true if any of the values specified in the source LongIterable are contained in the LongIterable, and false if they are not.

Since: 11.0

containsNone	back to summary
public default boolean containsNone(long... source) Returns true if none of the values specified in the source array are contained in the LongIterable, and false if they are. Since 11.0

containsNone

back to summary

public default boolean containsNone(long... source)

Returns true if none of the values specified in the source array are contained in the LongIterable, and false if they are.

Since: 11.0

containsNone	back to summary
public default boolean containsNone(LongIterable source) Returns true if none of the values specified in the source LongIterable are contained in the LongIterable, and false if they are. Since 11.0

containsNone

back to summary

public default boolean containsNone(LongIterable source)

Returns true if none of the values specified in the source LongIterable are contained in the LongIterable, and false if they are.

Since: 11.0

count	back to summary
public int count(LongPredicate predicate) Returns a count of the number of elements in the LongIterable that return true for the specified predicate.

detectIfNone	back to summary
public long detectIfNone(LongPredicate predicate, long ifNone)

each	back to summary
public void each(LongProcedure procedure) A synonym for forEach. Since 7.0.

each

back to summary

public void each(LongProcedure procedure)

A synonym for forEach.

Since: 7.0.

flatCollect back to summary

flatCollect	back to summary
public default <V, R extends Collection<V>> R flatCollect(LongToObjectFunction<? extends Iterable<V>> function, R target) `flatCollect` is a special case of `collect(LongToObjectFunction)`. With `collect`, when the `LongToObjectFunction` 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.

public default <V, R extends Collection<V>> R flatCollect(LongToObjectFunction<? extends Iterable<V>> function, R target)

flatCollect is a special case of collect(LongToObjectFunction). With collect, when the LongToObjectFunction 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.

forEach	back to summary
public default void forEach(LongProcedure procedure) Applies the LongProcedure to each element in the LongIterable.

injectInto	back to summary
public <T> T injectInto(T injectedValue, ObjectLongToObjectFunction<? super T, ? extends T> function)

injectIntoBoolean	back to summary
public default boolean injectIntoBoolean(boolean injectedValue, BooleanLongToBooleanFunction function) Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoBoolean

back to summary

public default boolean injectIntoBoolean(boolean injectedValue, BooleanLongToBooleanFunction function)

Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoByte	back to summary
public default byte injectIntoByte(byte injectedValue, ByteLongToByteFunction function) Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoByte

back to summary

public default byte injectIntoByte(byte injectedValue, ByteLongToByteFunction function)

Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoChar	back to summary
public default char injectIntoChar(char injectedValue, CharLongToCharFunction function) Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoChar

back to summary

public default char injectIntoChar(char injectedValue, CharLongToCharFunction function)

Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoDouble	back to summary
public default double injectIntoDouble(double injectedValue, DoubleLongToDoubleFunction function) Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoDouble

back to summary

public default double injectIntoDouble(double injectedValue, DoubleLongToDoubleFunction function)

Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoFloat	back to summary
public default float injectIntoFloat(float injectedValue, FloatLongToFloatFunction function) Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoFloat

back to summary

public default float injectIntoFloat(float injectedValue, FloatLongToFloatFunction function)

Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoInt	back to summary
public default int injectIntoInt(int injectedValue, IntLongToIntFunction function) Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoInt

back to summary

public default int injectIntoInt(int injectedValue, IntLongToIntFunction function)

Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoLong	back to summary
public default long injectIntoLong(long injectedValue, LongLongToLongFunction function) Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoLong

back to summary

public default long injectIntoLong(long injectedValue, LongLongToLongFunction function)

Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

injectIntoShort	back to summary
public default short injectIntoShort(short injectedValue, ShortLongToShortFunction function) Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. Since 11.1

injectIntoShort

back to summary

public default short injectIntoShort(short injectedValue, ShortLongToShortFunction function)

Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Since: 11.1

longIterator	back to summary
public LongIterator longIterator() Returns a primitive iterator that can be used to iterate over the LongIterable in an imperative style.

max	back to summary
public long max()

maxIfEmpty	back to summary
public long maxIfEmpty(long defaultValue)

median	back to summary
public double median()

medianIfEmpty	back to summary
public default double medianIfEmpty(double defaultValue) Since 9.0

min	back to summary
public long min()

minIfEmpty	back to summary
public long minIfEmpty(long defaultValue)

noneSatisfy	back to summary
public default boolean noneSatisfy(LongPredicate predicate) Returns true if none of the elements in the LongIterable return true for the specified predicate, otherwise returns false.

reduce	back to summary
public default long reduce(LongLongToLongFunction accumulator) Since 10.0 See Also `RichIterable#reduce(BinaryOperator)`

reduceIfEmpty	back to summary
public default long reduceIfEmpty(LongLongToLongFunction accumulator, long defaultValue) Since 10.0 See Also `reduce(LongLongToLongFunction)`

reject	back to summary
public LongIterable reject(LongPredicate predicate) Returns a new LongIterable with all of the elements in the LongIterable that return false for the specified predicate.

reject back to summary

reject	back to summary
public default <R extends MutableLongCollection> R reject(LongPredicate predicate, R target) Same as `reject(LongPredicate)` , only the results are added to the target MutableLongCollection. Since 8.1.

public default <R extends MutableLongCollection> R reject(LongPredicate predicate, R target)

Same as reject(LongPredicate) , only the results are added to the target MutableLongCollection.

Since: 8.1.

select	back to summary
public LongIterable select(LongPredicate predicate) Returns a new LongIterable with all of the elements in the LongIterable that return true for the specified predicate.

select back to summary

public default <R extends MutableLongCollection> R select(LongPredicate predicate, R target)

Same as select(LongPredicate) , only the results are added to the target MutableLongCollection.

Since: 8.1.

sum	back to summary
public long sum()

summaryStatistics	back to summary
public default LongSummaryStatistics summaryStatistics() Since 8.0

tap	back to summary
public default LongIterable tap(LongProcedure procedure) Since 9.0.

toArray	back to summary
public long[] toArray() Converts the LongIterable to a primitive long array.

toArray	back to summary
public default long[] toArray(long[] target) Converts the LongIterable to a primitive long array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

toBag	back to summary
public MutableLongBag toBag() Converts the LongIterable to a new MutableLongBag.

toList	back to summary
public MutableLongList toList() Converts the LongIterable to a new MutableLongList.

toSet	back to summary
public MutableLongSet toSet() Converts the LongIterable to a new MutableLongSet.

toSortedArray	back to summary
public long[] toSortedArray()

toSortedList	back to summary
public MutableLongList toSortedList()

toSortedList	back to summary
public default MutableLongList toSortedList(LongComparator comparator) Converts the collection to a MutableLongList implementation sorted using the provided comparator.

toSortedListBy	back to summary
public default <T> MutableLongList toSortedListBy(LongToObjectFunction<T> function) Converts the collection to a MutableLongListImplementation sorted based on the natural order of the key returned by `function`.

toSortedListBy	back to summary
public default <T> MutableLongList toSortedListBy(LongToObjectFunction<T> function, Comparator<? super T> comparator) Converts the collection to a MutableLongList implementation, which is sorted based on the key returned by `function` using the provided `comparator`.

public Interface LongIterable

Method Summary

Method Detail