ObjectList

public final boolean any()

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

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

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

public abstract @NonNull List<@NonNull E> asList()

Returns a List view into the ObjectList. All access to the collection will be less efficient and abides by the allocation requirements of the List. For example, List.forEach will allocate an iterator. All access will go through the more expensive interface calls. Critical performance areas should use the ObjectList API rather than List API, when possible.

public final boolean contains(@NonNull E element)

Returns true if the ObjectList contains element or false otherwise.

public final boolean containsAll(@NonNull E[] elements)

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

public final boolean containsAll(@NonNull Iterable<@NonNull E> elements)

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

public final boolean containsAll(@NonNull List<@NonNull E> elements)

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

public final boolean containsAll(@NonNull ObjectList<@NonNull E> elements)

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

public final int count()

Returns the number of elements in this list.

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

Counts the number of elements matching predicate.

public final @NonNull E 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.

public final @NonNull E elementAtOrElse(
    @IntRange(from = 0) int index,
    @NonNull Function1<@NonNull Integer, @NonNull E> defaultValue
)

Returns the element at the given index or defaultValue if index is out of bounds of the collection.

public boolean equals(Object other)

Returns true if other is a ObjectList and the contents of this and other are the same.

public final @NonNull E first()

Returns the first element in the ObjectList or throws a NoSuchElementException if it isEmpty.

public final @NonNull E first(@NonNull Function1<@NonNull element, @NonNull Boolean> predicate)

Returns the first element in the ObjectList for which predicate returns true or throws NoSuchElementException if nothing matches.

public final E firstOrNull()

Returns the first element in the ObjectList or null if it isEmpty.

public final E firstOrNull(
    @NonNull Function1<@NonNull element, @NonNull Boolean> predicate
)

Returns the first element in the ObjectList for which predicate returns true or null if nothing matches.

public final @NonNull R <R extends Object> fold(
    @NonNull R initial,
    @NonNull Function2<@NonNull acc, @NonNull element, @NonNull R> operation
)

Accumulates values, starting with initial, and applying operation to each element in the ObjectList in order.

public final @NonNull R <R extends Object> foldIndexed(
    @NonNull R initial,
    @NonNull Function3<@NonNull Integer, @NonNull acc, @NonNull element, @NonNull R> operation
)

Accumulates values, starting with initial, and applying operation to each element in the ObjectList in order.

public final @NonNull R <R extends Object> foldRight(
    @NonNull R initial,
    @NonNull Function2<@NonNull element, @NonNull acc, @NonNull R> operation
)

Accumulates values, starting with initial, and applying operation to each element in the ObjectList in reverse order.

public final @NonNull R <R extends Object> foldRightIndexed(
    @NonNull R initial,
    @NonNull Function3<@NonNull Integer, @NonNull element, @NonNull acc, @NonNull R> operation
)

Accumulates values, starting with initial, and applying operation to each element in the ObjectList in reverse order.

public final void forEach(@NonNull Function1<@NonNull element, Unit> block)

Calls block for each element in the ObjectList, in order.

public final void forEachIndexed(
    @NonNull Function2<@NonNull Integer, @NonNull element, Unit> block
)

Calls block for each element in the ObjectList along with its index, in order.

public final void forEachReversed(@NonNull Function1<@NonNull element, Unit> block)

Calls block for each element in the ObjectList in reverse order.

public final void forEachReversedIndexed(
    @NonNull Function2<@NonNull Integer, @NonNull element, Unit> block
)

Calls block for each element in the ObjectList along with its index, in reverse order.

public final @NonNull E 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.

public final @NonNull IntRange getIndices()

Returns an IntRange of the valid indices for this ObjectList.

public final @IntRange(from = -1) int getLastIndex()

Returns the last valid index in the ObjectList. This can be -1 when the list is empty.

public final @IntRange(from = 0) int getSize()

The number of elements in the ObjectList.

public int hashCode()

Returns a hash code based on the contents of the ObjectList.

public final int indexOf(@NonNull E element)

Returns the index of element in the ObjectList or -1 if element is not there.

public final int indexOfFirst(
    @NonNull Function1<@NonNull element, @NonNull Boolean> predicate
)

Returns the index if the first element in the ObjectList for which predicate returns true or -1 if there was no element for which predicate returned true.

public final int indexOfLast(
    @NonNull Function1<@NonNull element, @NonNull Boolean> predicate
)

Returns the index if the last element in the ObjectList for which predicate returns true or -1 if there was no element for which predicate returned true.

public final boolean isEmpty()

Returns true if the ObjectList has no elements in it or false otherwise.

public final boolean isNotEmpty()

Returns true if there are elements in the ObjectList or false if it is empty.

public final @NonNull String joinToString(
    @NonNull CharSequence separator,
    @NonNull CharSequence prefix,
    @NonNull CharSequence postfix,
    int limit,
    @NonNull CharSequence truncated,
    Function1<@NonNull E, @NonNull CharSequence> transform
)

Creates a String from the elements separated by separator and using prefix before and postfix after, if supplied.

When a non-negative value of limit is provided, a maximum of limit items are used to generate the string. If the collection holds more than limit items, the string is terminated with truncated.

transform may be supplied to convert each element to a custom String.

public final @NonNull E last()

Returns the last element in the ObjectList or throws a NoSuchElementException if it isEmpty.

public final @NonNull E last(@NonNull Function1<@NonNull element, @NonNull Boolean> predicate)

Returns the last element in the ObjectList for which predicate returns true or throws NoSuchElementException if nothing matches.

public final int lastIndexOf(@NonNull E element)

Returns the index of the last element in the ObjectList that is the same as element or -1 if no elements match.

public final E lastOrNull()

Returns the last element in the ObjectList or null if it isEmpty.

public final E lastOrNull(@NonNull Function1<@NonNull element, @NonNull Boolean> predicate)

Returns the last element in the ObjectList for which predicate returns true or null if nothing matches.

public final boolean none()

Returns true if the collection has no elements in it.

public final boolean reversedAny(
    @NonNull Function1<@NonNull element, @NonNull Boolean> predicate
)

Returns true if any of the elements give a true return value for predicate while iterating in the reverse order.

public @NonNull String toString()

Returns a String representation of the list, surrounded by "[]" and each element separated by ", ".