LongList

Artifact: androidx.collection:collection

Added in 1.4.0

Kotlin |Java

public sealed class LongList

Known direct subclasses

MutableLongList

MutableLongList

MutableLongList is a MutableList-like collection for Long values.

LongList is a List-like collection for Long values. It allows retrieving the elements without boxing. LongList is always backed by a MutableLongList, its MutableList-like subclass. The purpose of this class is to avoid the performance overhead of auto-boxing due to generics since Collection classes all operate on objects.

This implementation is not thread-safe: if multiple threads access this container concurrently, and one or more threads modify the structure of the list (insertion or removal for instance), the calling code must provide the appropriate synchronization. It is also not safe to mutate during reentrancy -- in the middle of a forEach, for example. However, concurrent reads are safe.

Summary

Protected constructors
`LongList(int initialCapacity)`

Public methods
`final boolean`	`any()` Returns `true` if there's at least one element in the collection.
`final boolean`	`any(@NonNull Function1<@NonNull Long, @NonNull Boolean> predicate)` Returns `true` if any of the elements give a `true` return value for `predicate`.
`final int`	`binarySearch(int element, int fromIndex, int toIndex)` Searches this list the specified element in the range defined by `fromIndex` and `toIndex`.
`final boolean`	`contains(long element)` Returns `true` if the `LongList` contains `element` or `false` otherwise.
`final boolean`	`containsAll(@NonNull LongList elements)` Returns `true` if the `LongList` contains all elements in `elements` or `false` if one or more are missing.
`final int`	`count()` Returns the number of elements in this list.
`final int`	`count(@NonNull Function1<@NonNull Long, @NonNull Boolean> predicate)` Counts the number of elements matching `predicate`.
`final long`	`elementAt(@IntRange(from = 0) int index)` Returns the element at the given `index` or throws `IndexOutOfBoundsException` if the `index` is out of bounds of this collection.
`final long`	`elementAtOrElse( @IntRange(from = 0) int index, @NonNull Function1<@NonNull Integer, @NonNull Long> defaultValue )` Returns the element at the given `index` or `defaultValue` if `index` is out of bounds of the collection.
`boolean`	`equals(Object other)` Returns `true` if `other` is a `LongList` and the contents of this and `other` are the same.
`final long`	`first()` Returns the first element in the `LongList` or throws a `NoSuchElementException` if it `isEmpty`.
`final long`	`first(@NonNull Function1<@NonNull Long, @NonNull Boolean> predicate)` Returns the first element in the `LongList` for which `predicate` returns `true` or throws `NoSuchElementException` if nothing matches.
`final @NonNull R`	`<R extends Object> fold( @NonNull R initial, @NonNull Function2<@NonNull acc, @NonNull Long, @NonNull R> operation )` Accumulates values, starting with `initial`, and applying `operation` to each element in the `LongList` in order.
`final @NonNull R`	`<R extends Object> foldIndexed( @NonNull R initial, @NonNull Function3<@NonNull Integer, @NonNull acc, @NonNull Long, @NonNull R> operation )` Accumulates values, starting with `initial`, and applying `operation` to each element in the `LongList` in order.
`final @NonNull R`	`<R extends Object> foldRight( @NonNull R initial, @NonNull Function2<@NonNull Long, @NonNull acc, @NonNull R> operation )` Accumulates values, starting with `initial`, and applying `operation` to each element in the `LongList` in reverse order.
`final @NonNull R`	`<R extends Object> foldRightIndexed( @NonNull R initial, @NonNull Function3<@NonNull Integer, @NonNull Long, @NonNull acc, @NonNull R> operation )` Accumulates values, starting with `initial`, and applying `operation` to each element in the `LongList` in reverse order.
`final void`	`forEach(@NonNull Function1<@NonNull Long, Unit> block)` Calls `block` for each element in the `LongList`, in order.
`final void`	`forEachIndexed( @NonNull Function2<@NonNull Integer, @NonNull Long, Unit> block )` Calls `block` for each element in the `LongList` along with its index, in order.
`final void`	`forEachReversed(@NonNull Function1<@NonNull Long, Unit> block)` Calls `block` for each element in the `LongList` in reverse order.
`final void`	`forEachReversedIndexed( @NonNull Function2<@NonNull Integer, @NonNull Long, Unit> block )` Calls `block` for each element in the `LongList` along with its index, in reverse order.
`final long`	`get(@IntRange(from = 0) int index)` Returns the element at the given `index` or throws `IndexOutOfBoundsException` if the `index` is out of bounds of this collection.
`final @NonNull IntRange`	`getIndices()` Returns an `IntRange` of the valid indices for this `LongList`.
`final @IntRange(from = -1) int`	`getLastIndex()` Returns the last valid index in the `LongList`.
`final @IntRange(from = 0) int`	`getSize()` The number of elements in the `LongList`.
`int`	`hashCode()` Returns a hash code based on the contents of the `LongList`.
`final int`	`indexOf(long element)` Returns the index of `element` in the `LongList` or `-1` if `element` is not there.
`final int`	`indexOfFirst(@NonNull Function1<@NonNull Long, @NonNull Boolean> predicate)` Returns the index if the first element in the `LongList` for which `predicate` returns `true`.
`final int`	`indexOfLast(@NonNull Function1<@NonNull Long, @NonNull Boolean> predicate)` Returns the index if the last element in the `LongList` for which `predicate` returns `true`.
`final boolean`	`isEmpty()` Returns `true` if the `LongList` has no elements in it or `false` otherwise.
`final boolean`	`isNotEmpty()` Returns `true` if there are elements in the `LongList` or `false` if it is empty.
`final @NonNull String`	`joinToString( @NonNull CharSequence separator, @NonNull CharSequence prefix, @NonNull CharSequence postfix, int limit, @NonNull CharSequence truncated )` Creates a String from the elements separated by `separator` and using `prefix` before and `postfix` after, if supplied.
`final @NonNull String`	`joinToString( @NonNull CharSequence separator, @NonNull CharSequence prefix, @NonNull CharSequence postfix, int limit, @NonNull CharSequence truncated, @NonNull Function1<@NonNull Long, @NonNull CharSequence> transform )` Creates a String from the elements separated by `separator` and using `prefix` before and `postfix` after, if supplied.
`final long`	`last()` Returns the last element in the `LongList` or throws a `NoSuchElementException` if it `isEmpty`.
`final long`	`last(@NonNull Function1<@NonNull Long, @NonNull Boolean> predicate)` Returns the last element in the `LongList` for which `predicate` returns `true` or throws `NoSuchElementException` if nothing matches.
`final int`	`lastIndexOf(long element)` Returns the index of the last element in the `LongList` that is the same as `element` or `-1` if no elements match.
`final boolean`	`none()` Returns `true` if the collection has no elements in it.
`final boolean`	`reversedAny(@NonNull Function1<@NonNull Long, @NonNull Boolean> predicate)` Returns `true` if any of the elements give a `true` return value for `predicate` while iterating in the reverse order.
`@NonNull String`	`toString()` Returns a String representation of the list, surrounded by "[]" and each element separated by ", ".

Protected constructors

LongList

protected LongList(int initialCapacity)

Public methods

any

Added in 1.4.0

public final boolean any()

Returns true if there's at least one element in the collection.

any

Added in 1.4.0

public final boolean any(@NonNull Function1<@NonNull Long, @NonNull Boolean> predicate)

Returns true if any of the elements give a true return value for predicate.

binarySearch

Added in 1.5.0

public final int binarySearch(int element, int fromIndex, int toIndex)

Searches this list the specified element in the range defined by fromIndex and toIndex. The list is expected to be sorted into ascending order according to the natural ordering of its elements, otherwise the result is undefined.

fromIndex must be >= 0 and <toIndex, and toIndex must be <= size, otherwise an an IndexOutOfBoundsException will be thrown.

Returns
`int`	the index of the element if it is contained in the list within the specified range. otherwise, the inverted insertion point `(-insertionPoint - 1)`. The insertion point is defined as the index at which the element should be inserted, so that the list remains sorted.

contains

Added in 1.4.0

public final boolean contains(long element)

Returns true if the LongList contains element or false otherwise.

containsAll

Added in 1.4.0

public final boolean containsAll(@NonNull LongList elements)

Returns true if the LongList contains all elements in elements or false if one or more are missing.

count

Added in 1.4.0

public final int count()

Returns the number of elements in this list.

count

Added in 1.4.0

public final int count(@NonNull Function1<@NonNull Long, @NonNull Boolean> predicate)

Counts the number of elements matching predicate.

Returns
`int`	The number of elements in this list for which `predicate` returns true.

elementAt

Added in 1.4.0

public final long elementAt(@IntRange(from = 0) int index)

Returns the element at the given index or throws IndexOutOfBoundsException if the index is out of bounds of this collection.