ObjectList

fun any(): Boolean

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

inline fun any(predicate: (element) -> Boolean): Boolean

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

abstract fun asList(): List<E>

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.

operator fun contains(element: E): Boolean

Returns true if the ObjectList contains element or false otherwise.

fun containsAll(elements: Array<E>): Boolean

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

fun containsAll(elements: Iterable<E>): Boolean

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

fun containsAll(elements: List<E>): Boolean

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

fun containsAll(elements: ObjectList<E>): Boolean

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

fun count(): Int

Returns the number of elements in this list.

inline fun count(predicate: (element) -> Boolean): Int

Counts the number of elements matching predicate.

fun elementAt(index: @IntRange(from = 0) Int): E

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

inline fun elementAtOrElse(index: @IntRange(from = 0) Int, defaultValue: (index: Int) -> E): E

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

open operator fun equals(other: Any?): Boolean

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

fun first(): E

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

inline fun first(predicate: (element) -> Boolean): E

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

inline fun firstOrNull(): E?

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

inline fun firstOrNull(predicate: (element) -> Boolean): E?

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

inline fun <R : Any?> fold(initial: R, operation: (acc, element) -> R): R

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

inline fun <R : Any?> foldIndexed(initial: R, operation: (index: Int, acc, element) -> R): R

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

inline fun <R : Any?> foldRight(initial: R, operation: (element, acc) -> R): R

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

inline fun <R : Any?> foldRightIndexed(initial: R, operation: (index: Int, element, acc) -> R): R

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

inline fun forEach(block: (element) -> Unit): Unit

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

inline fun forEachIndexed(block: (index: Int, element) -> Unit): Unit

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

inline fun forEachReversed(block: (element) -> Unit): Unit

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

inline fun forEachReversedIndexed(block: (index: Int, element) -> Unit): Unit

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

operator fun get(index: @IntRange(from = 0) Int): E

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

open fun hashCode(): Int

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

fun indexOf(element: E): Int

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

inline fun indexOfFirst(predicate: (element) -> Boolean): Int

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.

inline fun indexOfLast(predicate: (element) -> Boolean): Int

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.

fun isEmpty(): Boolean

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

fun isNotEmpty(): Boolean

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

fun joinToString(
    separator: CharSequence = ", ",
    prefix: CharSequence = "",
    postfix: CharSequence = "",
    limit: Int = -1,
    truncated: CharSequence = "...",
    transform: ((E) -> CharSequence)? = null
): String

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.

fun last(): E

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

inline fun last(predicate: (element) -> Boolean): E

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

fun lastIndexOf(element: E): Int

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

inline fun lastOrNull(): E?

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

inline fun lastOrNull(predicate: (element) -> Boolean): E?

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

fun none(): Boolean

Returns true if the collection has no elements in it.

inline fun reversedAny(predicate: (element) -> Boolean): Boolean

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

open fun toString(): String

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

val indices: IntRange

Returns an IntRange of the valid indices for this ObjectList.

val lastIndex: Int

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

val size: Int

The number of elements in the ObjectList.