Package org.eclipse.collections.api

Interface LongIterable

All Superinterfaces:
PrimitiveIterable
All Known Subinterfaces:
ByteLongMap, CharLongMap, DoubleLongMap, FloatLongMap, ImmutableByteLongMap, ImmutableCharLongMap, ImmutableDoubleLongMap, ImmutableFloatLongMap, ImmutableIntLongMap, ImmutableLongBag, ImmutableLongCollection, ImmutableLongList, ImmutableLongLongMap, ImmutableLongSet, ImmutableLongStack, ImmutableObjectLongMap<K>, ImmutableShortLongMap, IntLongMap, LazyLongIterable, LongBag, LongList, LongLongMap, LongSet, LongStack, LongValuesMap, MutableByteLongMap, MutableCharLongMap, MutableDoubleLongMap, MutableFloatLongMap, MutableIntLongMap, MutableLongBag, MutableLongCollection, MutableLongList, MutableLongLongMap, MutableLongSet, MutableLongStack, MutableLongValuesMap, MutableObjectLongMap<K>, MutableShortLongMap, ObjectLongMap<K>, OrderedLongIterable, ReversibleLongIterable, ShortLongMap
All Known Implementing Classes:
AbstractImmutableLongSet, AbstractImmutableObjectLongMap, AbstractLazyLongIterable, AbstractLongIterable, AbstractLongSet, AbstractLongStack, AbstractMutableLongKeySet, AbstractMutableLongValuesMap, AbstractSynchronizedLongCollection, AbstractUnmodifiableLongCollection, ByteLongHashMap, CharLongHashMap, CollectBooleanToLongIterable, CollectByteToLongIterable, CollectCharToLongIterable, CollectDoubleToLongIterable, CollectFloatToLongIterable, CollectIntToLongIterable, CollectLongIterable, CollectLongToLongIterable, CollectShortToLongIterable, DoubleLongHashMap, FloatLongHashMap, IntLongHashMap, LazyLongIterableAdapter, LongArrayList, LongArrayStack, LongHashBag, LongHashSet, LongInterval, LongLongHashMap, ObjectLongHashMap, ObjectLongHashMapWithHashingStrategy, ReverseLongIterable, SelectLongIterable, ShortLongHashMap, SynchronizedByteLongMap, SynchronizedCharLongMap, SynchronizedDoubleLongMap, SynchronizedFloatLongMap, SynchronizedIntLongMap, SynchronizedLongBag, SynchronizedLongCollection, SynchronizedLongIterable, SynchronizedLongList, SynchronizedLongLongMap, SynchronizedLongSet, SynchronizedLongStack, SynchronizedObjectLongMap, SynchronizedShortLongMap, TapLongIterable, UnmodifiableByteLongMap, UnmodifiableCharLongMap, UnmodifiableDoubleLongMap, UnmodifiableFloatLongMap, UnmodifiableIntLongMap, UnmodifiableLongBag, UnmodifiableLongCollection, UnmodifiableLongList, UnmodifiableLongLongMap, UnmodifiableLongSet, UnmodifiableLongStack, UnmodifiableObjectLongMap, UnmodifiableShortLongMap
public interface LongIterable
extends PrimitiveIterable
LongIterable is an interface which is memory-optimized for long 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 LongIterator. LongIterator helps iterate over the LongIterable without boxing the primitives. This file was automatically generated from template file primitiveIterable.stg.

  • Method Details

    • longIterator

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

    • toArray

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

    • toArray

      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.

    • contains

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

    • containsAll

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

    • containsAll

      boolean containsAll​(LongIterable source)
      Returns true if the all of the values specified in the source LongIterable are contained in the LongIterable, and false if they are not.

    • forEach

      void forEach​(LongProcedure procedure)
      Applies the LongProcedure to each element in the LongIterable.

    • each

      void each​(LongProcedure procedure)
      A synonym for forEach.
      Since:
      7.0.

    • tap

      default LongIterable tap​(LongProcedure procedure)
      Since:
      9.0.

    • select

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

    • reject

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

    • select

      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.

    • reject

      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.

    • collect

      <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

      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.

    • flatCollect

      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.

    • collectBoolean

      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

      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

      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.

    • collectShort

      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.

    • collectInt

      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.

    • collectFloat

      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.

    • collectLong

      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.

    • collectDouble

      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.

    • detectIfNone

      long detectIfNone​(LongPredicate predicate, long ifNone)

    • count

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

    • anySatisfy

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

    • allSatisfy

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

    • noneSatisfy

      boolean noneSatisfy​(LongPredicate predicate)
      Returns true if none of the elements in the LongIterable return true for the specified predicate, otherwise returns false.

    • toList

      MutableLongList toList()
      Converts the LongIterable to a new MutableLongList.

    • toSet

      MutableLongSet toSet()
      Converts the LongIterable to a new MutableLongSet.

    • toBag

      MutableLongBag toBag()
      Converts the LongIterable to a new MutableLongBag.

    • asLazy

      LazyLongIterable asLazy()
      Returns a LazyLongIterable adapter wrapping the source LongIterable.

    • injectInto

      <T> T injectInto​(T injectedValue, ObjectLongToObjectFunction<? super T,​? extends T> function)

    • reduceIfEmpty

      default long reduceIfEmpty​(LongLongToLongFunction accumulator, long defaultValue)
      Since:
      10.0
      See Also:
      reduce(LongLongToLongFunction)

    • reduce

      default long reduce​(LongLongToLongFunction accumulator)
      Since:
      10.0
      See Also:
      RichIterable.reduce(BinaryOperator)

    • chunk

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

    • sum

      long sum()

    • summaryStatistics

      default LongSummaryStatistics summaryStatistics()
      Since:
      8.0

    • max

      long max()

    • maxIfEmpty

      long maxIfEmpty​(long defaultValue)

    • min

      long min()

    • minIfEmpty

      long minIfEmpty​(long 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

      long[] toSortedArray()

    • toSortedList

      MutableLongList toSortedList()