MutableIntList


public final class MutableIntList extends IntList


MutableIntList is a MutableList-like collection for Int values. It allows storing and retrieving the elements without boxing. Immutable access is available through its base class IntList, which has a List-like interface.

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

Public constructors

MutableIntList(int initialCapacity)

Creates a MutableIntList with a capacity of initialCapacity.

Public methods

final boolean
add(int element)

Adds element to the MutableIntList and returns true.

final void
add(@IntRange(from = 0) int index, int element)

Adds element to the MutableIntList at the given index, shifting over any elements at index and after, if any.

final boolean
addAll(@NonNull int[] elements)

Adds all elements to the end of the MutableIntList and returns true if the MutableIntList was changed or false if elements was empty.

final boolean
addAll(@NonNull IntList elements)

Adds all elements to the end of the MutableIntList and returns true if the MutableIntList was changed or false if elements was empty.

final boolean
addAll(@IntRange(from = 0) int index, @NonNull int[] elements)

Adds all elements to the MutableIntList at the given index, shifting over any elements at index and after, if any.

final boolean
addAll(@IntRange(from = 0) int index, @NonNull IntList elements)

Adds all elements to the MutableIntList at the given index, shifting over any elements at index and after, if any.

final void

Removes all elements in the MutableIntList.

final void
ensureCapacity(int capacity)

Ensures that there is enough space to store capacity elements in the MutableIntList.

final int

Returns the total number of elements that can be held before the MutableIntList must grow.

final void
minusAssign(int element)

remove from the MutableIntList

final void
minusAssign(@NonNull int[] elements)

Removes all elements from the MutableIntList.

final void

Removes all elements from the MutableIntList.

final void
plusAssign(int element)

add to the MutableIntList.

final void
plusAssign(@NonNull int[] elements)

Adds all elements to the end of the MutableIntList.

final void

Adds all elements to the end of the MutableIntList.

final boolean
remove(int element)

Removes element from the MutableIntList.

final boolean
removeAll(@NonNull int[] elements)

Removes all elements from the MutableIntList and returns true if anything was removed.

final boolean

Removes all elements from the MutableIntList and returns true if anything was removed.

final int
removeAt(@IntRange(from = 0) int index)

Removes the element at the given index and returns it.

final void
removeRange(@IntRange(from = 0) int start, @IntRange(from = 0) int end)

Removes items from index start (inclusive) to end (exclusive).

final boolean
retainAll(@NonNull int[] elements)

Keeps only elements in the MutableIntList and removes all other values.

final boolean

Keeps only elements in the MutableIntList and removes all other values.

final int
set(@IntRange(from = 0) int index, int element)

Sets the value at index to element.

final void

Sorts the MutableIntList elements in ascending order.

final void

Sorts the MutableIntList elements in descending order.

final void
trim(int minCapacity)

Reduces the internal storage.

Inherited methods

From androidx.collection.IntList
final boolean
any()

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

final boolean
any(@NonNull Function1<@NonNull Integer, @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(int element)

Returns true if the IntList contains element or false otherwise.

final boolean

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

final int

Returns the number of elements in this list.

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

Counts the number of elements matching predicate.

final int
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 int
elementAtOrElse(
    @IntRange(from = 0) int index,
    @NonNull Function1<@NonNull Integer, @NonNull Integer> 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 IntList and the contents of this and other are the same.

final int

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

final int
first(@NonNull Function1<@NonNull Integer, @NonNull Boolean> predicate)

Returns the first element in the IntList 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 Integer, @NonNull R> operation
)

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

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

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

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

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

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

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

final void
forEach(@NonNull Function1<@NonNull IntegerUnit> block)

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

final void
forEachIndexed(
    @NonNull Function2<@NonNull Integer, @NonNull IntegerUnit> block
)

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

final void
forEachReversed(@NonNull Function1<@NonNull IntegerUnit> block)

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

final void

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

final int
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

Returns an IntRange of the valid indices for this IntList.

final @IntRange(from = -1) int

Returns the last valid index in the IntList.

final @IntRange(from = 0) int

The number of elements in the IntList.

int

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

final int
indexOf(int element)

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

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

Returns the index if the first element in the IntList for which predicate returns true.

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

Returns the index if the last element in the IntList for which predicate returns true.

final boolean

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

final boolean

Returns true if there are elements in the IntList 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 Integer, @NonNull CharSequence> transform
)

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

final int

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

final int
last(@NonNull Function1<@NonNull Integer, @NonNull Boolean> predicate)

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

final int
lastIndexOf(int element)

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

final boolean

Returns true if the collection has no elements in it.

final boolean
reversedAny(
    @NonNull Function1<@NonNull Integer, @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

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

Public constructors

MutableIntList

Added in 1.4.0
public MutableIntList(int initialCapacity)

Creates a MutableIntList with a capacity of initialCapacity.

Public methods

add

Added in 1.4.0
public final boolean add(int element)

Adds element to the MutableIntList and returns true.

add

Added in 1.4.0
public final void add(@IntRange(from = 0) int index, int element)

Adds element to the MutableIntList at the given index, shifting over any elements at index and after, if any.

Throws
kotlin.IndexOutOfBoundsException

if index isn't between 0 and size, inclusive

addAll

Added in 1.4.0
public final boolean addAll(@NonNull int[] elements)

Adds all elements to the end of the MutableIntList and returns true if the MutableIntList was changed or false if elements was empty.

addAll

Added in 1.4.0
public final boolean addAll(@NonNull IntList elements)

Adds all elements to the end of the MutableIntList and returns true if the MutableIntList was changed or false if elements was empty.

addAll

Added in 1.4.0
public final boolean addAll(@IntRange(from = 0) int index, @NonNull int[] elements)

Adds all elements to the MutableIntList at the given index, shifting over any elements at index and after, if any.

Returns
boolean

true if the MutableIntList was changed or false if elements was empty

Throws
kotlin.IndexOutOfBoundsException

if index isn't between 0 and size, inclusive.

addAll

Added in 1.4.0
public final boolean addAll(@IntRange(from = 0) int index, @NonNull IntList elements)

Adds all elements to the MutableIntList at the given index, shifting over any elements at index and after, if any.

Returns
boolean

true if the MutableIntList was changed or false if elements was empty

Throws
kotlin.IndexOutOfBoundsException

if index isn't between 0 and size, inclusive

clear

Added in 1.4.0
public final void clear()

Removes all elements in the MutableIntList. The storage isn't released.

See also
trim

ensureCapacity

Added in 1.4.0
public final void ensureCapacity(int capacity)

Ensures that there is enough space to store capacity elements in the MutableIntList.

See also
trim

getCapacity

Added in 1.4.0
public final int getCapacity()

Returns the total number of elements that can be held before the MutableIntList must grow.

See also
ensureCapacity

minusAssign

Added in 1.4.0
public final void minusAssign(int element)

remove from the MutableIntList

minusAssign

Added in 1.4.0
public final void minusAssign(@NonNull int[] elements)

Removes all elements from the MutableIntList.

minusAssign

Added in 1.4.0
public final void minusAssign(@NonNull IntList elements)

Removes all elements from the MutableIntList.

plusAssign

Added in 1.4.0
public final void plusAssign(int element)

add to the MutableIntList.

plusAssign

Added in 1.4.0
public final void plusAssign(@NonNull int[] elements)

Adds all elements to the end of the MutableIntList.

plusAssign

Added in 1.4.0
public final void plusAssign(@NonNull IntList elements)

Adds all elements to the end of the MutableIntList.

remove

Added in 1.4.0
public final boolean remove(int element)

Removes element from the MutableIntList. If element was in the MutableIntList and was removed, true will be returned, or false will be returned if the element was not found.

removeAll

Added in 1.4.0
public final boolean removeAll(@NonNull int[] elements)

Removes all elements from the MutableIntList and returns true if anything was removed.

removeAll

Added in 1.4.0
public final boolean removeAll(@NonNull IntList elements)

Removes all elements from the MutableIntList and returns true if anything was removed.

removeAt

Added in 1.4.0
public final int removeAt(@IntRange(from = 0) int index)

Removes the element at the given index and returns it.

Throws
kotlin.IndexOutOfBoundsException

if index isn't between 0 and lastIndex, inclusive

removeRange

Added in 1.4.0
public final void removeRange(@IntRange(from = 0) int start, @IntRange(from = 0) int end)

Removes items from index start (inclusive) to end (exclusive).

Throws
kotlin.IndexOutOfBoundsException

if start or end isn't between 0 and size, inclusive

kotlin.IllegalArgumentException

if start is greater than end

retainAll

Added in 1.4.0
public final boolean retainAll(@NonNull int[] elements)

Keeps only elements in the MutableIntList and removes all other values.

Returns
boolean

true if the MutableIntList has changed.

retainAll

Added in 1.4.0
public final boolean retainAll(@NonNull IntList elements)

Keeps only elements in the MutableIntList and removes all other values.

Returns
boolean

true if the MutableIntList has changed.

set

Added in 1.4.0
public final int set(@IntRange(from = 0) int index, int element)

Sets the value at index to element.

Returns
int

the previous value set at index

Throws
kotlin.IndexOutOfBoundsException

if index isn't between 0 and lastIndex, inclusive

sort

Added in 1.4.0
public final void sort()

Sorts the MutableIntList elements in ascending order.

sortDescending

Added in 1.4.0
public final void sortDescending()

Sorts the MutableIntList elements in descending order.

trim

Added in 1.4.0
public final void trim(int minCapacity)

Reduces the internal storage. If capacity is greater than minCapacity and size, the internal storage is reduced to the maximum of size and minCapacity.

See also
ensureCapacity