ObjectListKt

Added in 1.4.0

public final class ObjectListKt


Summary

Public methods

static final int
<E extends Comparable<@NonNull E>> binarySearch(
    @NonNull ObjectList<@NonNull E> receiver,
    @NonNull E element,
    @IntRange(from = 0) int fromIndex,
    @IntRange(from = 0) int toIndex
)

Searches this ObjectList or its range for the provided element using binary search algorithm.

static final @NonNull ObjectList<@NonNull E>
<E extends Object> emptyObjectList()
static final @NonNull MutableObjectList<@NonNull E>
<E extends Object> mutableObjectListOf()
static final @NonNull MutableObjectList<@NonNull E>
<E extends Object> mutableObjectListOf(@NonNull E element1)
static final @NonNull MutableObjectList<@NonNull E>
<E extends Object> mutableObjectListOf(@NonNull E... elements)
static final @NonNull MutableObjectList<@NonNull E>
<E extends Object> mutableObjectListOf(@NonNull E element1, @NonNull E element2)
static final @NonNull MutableObjectList<@NonNull E>
<E extends Object> mutableObjectListOf(
    @NonNull E element1,
    @NonNull E element2,
    @NonNull E element3
)
static final @NonNull ObjectList<@NonNull E>
<E extends Object> objectListOf()
static final @NonNull ObjectList<@NonNull E>
<E extends Object> objectListOf(@NonNull E element1)
static final @NonNull ObjectList<@NonNull E>
<E extends Object> objectListOf(@NonNull E... elements)
static final @NonNull ObjectList<@NonNull E>
<E extends Object> objectListOf(@NonNull E element1, @NonNull E element2)
static final @NonNull ObjectList<@NonNull E>
<E extends Object> objectListOf(
    @NonNull E element1,
    @NonNull E element2,
    @NonNull E element3
)
static final void
<E extends Comparable<@NonNull E>> sort(
    @NonNull MutableObjectList<@NonNull E> receiver
)

Sorts elements in the MutableObjectList of Comparable elements in-place in ascending order.

static final void
<E extends Comparable<@NonNull E>> sortDescending(
    @NonNull MutableObjectList<@NonNull E> receiver
)

Sorts elements in the MutableObjectList of Comparable elements in-place in descending order.

Public methods

public static final int <E extends Comparable<@NonNull E>> binarySearch(
    @NonNull ObjectList<@NonNull E> receiver,
    @NonNull E element,
    @IntRange(from = 0) int fromIndex,
    @IntRange(from = 0) int toIndex
)

Searches this ObjectList or its range for the provided element using binary search algorithm. The list is expected to be sorted in ascending order according to the natural ordering of elements.

emptyObjectList

public static final @NonNull ObjectList<@NonNull E> <E extends Object> emptyObjectList()
Returns
@NonNull ObjectList<@NonNull E>

a read-only ObjectList with nothing in it.

mutableObjectListOf

public static final @NonNull MutableObjectList<@NonNull E> <E extends Object> mutableObjectListOf()
Returns
@NonNull MutableObjectList<@NonNull E>

a new empty MutableObjectList with the default capacity.

mutableObjectListOf

public static final @NonNull MutableObjectList<@NonNull E> <E extends Object> mutableObjectListOf(@NonNull E element1)
Returns
@NonNull MutableObjectList<@NonNull E>

a new MutableObjectList with element1 as the only element in the list.

mutableObjectListOf

public static final @NonNull MutableObjectList<@NonNull E> <E extends Object> mutableObjectListOf(@NonNull E... elements)
Returns
@NonNull MutableObjectList<@NonNull E>

a new MutableObjectList with the given elements, in order.

mutableObjectListOf

public static final @NonNull MutableObjectList<@NonNull E> <E extends Object> mutableObjectListOf(@NonNull E element1, @NonNull E element2)
Returns
@NonNull MutableObjectList<@NonNull E>

a new MutableObjectList with 2 elements, element1 and element2, in order.

mutableObjectListOf

public static final @NonNull MutableObjectList<@NonNull E> <E extends Object> mutableObjectListOf(
    @NonNull E element1,
    @NonNull E element2,
    @NonNull E element3
)
Returns
@NonNull MutableObjectList<@NonNull E>

a new MutableObjectList with 3 elements, element1, element2, and element3, in order.

objectListOf

public static final @NonNull ObjectList<@NonNull E> <E extends Object> objectListOf()
Returns
@NonNull ObjectList<@NonNull E>

a read-only ObjectList with nothing in it.

objectListOf

public static final @NonNull ObjectList<@NonNull E> <E extends Object> objectListOf(@NonNull E element1)
Returns
@NonNull ObjectList<@NonNull E>

a new read-only ObjectList with element1 as the only element in the list.

objectListOf

public static final @NonNull ObjectList<@NonNull E> <E extends Object> objectListOf(@NonNull E... elements)
Returns
@NonNull ObjectList<@NonNull E>

a new read-only ObjectList with elements in order.

objectListOf

public static final @NonNull ObjectList<@NonNull E> <E extends Object> objectListOf(@NonNull E element1, @NonNull E element2)
Returns
@NonNull ObjectList<@NonNull E>

a new read-only ObjectList with 2 elements, element1 and element2, in order.

objectListOf

public static final @NonNull ObjectList<@NonNull E> <E extends Object> objectListOf(
    @NonNull E element1,
    @NonNull E element2,
    @NonNull E element3
)
Returns
@NonNull ObjectList<@NonNull E>

a new read-only ObjectList with 3 elements, element1, element2, and element3, in order.

public static final void <E extends Comparable<@NonNull E>> sort(
    @NonNull MutableObjectList<@NonNull E> receiver
)

Sorts elements in the MutableObjectList of Comparable elements in-place in ascending order.

sortDescending

public static final void <E extends Comparable<@NonNull E>> sortDescending(
    @NonNull MutableObjectList<@NonNull E> receiver
)

Sorts elements in the MutableObjectList of Comparable elements in-place in descending order.