module-common/dev.racci.minix.api.collections.expiring/ExpirationCollection

ExpirationCollection

@ApiStatus.Experimental

@ApiStatus.AvailableSince(value = "5.0.0")

interface ExpirationCollection<E> : Collection<E>

The basic interface for implementing a collection of expiring elements.

Parameters

The type of element in the collection.

Functions

add

abstract fun add(element: E, expireIn: Duration, onExpire: ExpirationCallback<E>? = null)

Adds the given element to the collection.

addAll

abstract fun addAll(expireIn: Duration, vararg elements: E, onExpire: ExpirationCallback<E>? = null)

Adds all the given elements to the collection.

addFirst

abstract fun addFirst(element: E, expireIn: Duration, onExpire: ExpirationCallback<E>? = null)

Adds the given element to the beginning of the collection.

addLast

abstract fun addLast(element: E, expireIn: Duration, onExpire: ExpirationCallback<E>? = null)

Adds the given element to the end of the collection. This is the same as add.

clear

abstract fun clear(callCallbacks: Boolean = false)

Removes all the elements from the collection, possibly calling the callback on each element.

contains

abstract operator fun contains(element: E): Boolean

containsAll

abstract fun containsAll(elements: Collection<E>): Boolean

first

abstract fun first(): E?

Provides the element at the beginning of the collection.

forEach

open fun forEach(p0: Consumer<in E>)

get

abstract operator fun get(index: Int): E?

Provides the element at the given index in the collection.

indexOf

abstract fun indexOf(element: E): Int

Provides the index of the given element in the collection.

isEmpty

abstract fun isEmpty(): Boolean

iterator

abstract operator override fun iterator(): Iterator<E>

last

abstract fun last(): E?

Provides the element at the end of the collection.

parallelStream

open fun parallelStream(): Stream<E>

remove

abstract fun remove(element: E): Boolean

Removes the give element from the collection if it is present.

removeAt

abstract fun removeAt(index: Int): E?

Removes the element at the given index from the collection if it is present.

removeFirst

abstract fun removeFirst(): E?

Removes the element at the beginning of the collection if it is present.

removeLast

abstract fun removeLast(): E?

Removes the element at the end of the collection if it is present.

spliterator

open override fun spliterator(): Spliterator<E>

stream

open fun stream(): Stream<E>

toArray

open fun <T : Any> ~~toArray~~(p0: IntFunction<Array<T>>): Array<T>

Properties

size

abstract val size: Int

Inheritors

ExpirationListImpl

Extensions

contains

fun Collection<String>.contains(value: String, ignoreCase: Boolean = false): Boolean

findKCallable

fun <T : KCallable<*>> Collection<T>.findKCallable(name: String, ignoreCase: Boolean = false): Option<T>

findKFunction

@JvmName(name = "findKFunction")

inline fun <R> Collection<KFunction<*>>.findKFunction(name: String, ignoreCase: Boolean = false): Option<KFunction<R>>

@JvmName(name = "findKFunction0")

inline fun <R> Collection<() -> *>.findKFunction(name: String, ignoreCase: Boolean = false): Option<() -> R>

@JvmName(name = "findKFunction1")

inline fun <R> Collection<(*) -> *>.findKFunction(name: String, ignoreCase: Boolean = false): Option<(Any) -> R>

@JvmName(name = "findKFunction2")

inline fun <R> Collection<(*, *) -> *>.findKFunction(name: String, ignoreCase: Boolean = false): Option<(*, *) -> R>

findKProperty

@JvmName(name = "findKProperty0")

inline fun <R> Collection<KProperty0<*>>.findKProperty(name: String, ignoreCase: Boolean = false): Option<KProperty0<R>>

@JvmName(name = "findKProperty1")

inline fun <R> Collection<KProperty1<*, *>>.findKProperty(name: String, ignoreCase: Boolean = false): Option<KProperty1<Any, R>>

@JvmName(name = "findKProperty2")

inline fun <R> Collection<KProperty2<*, *, *>>.findKProperty(name: String, ignoreCase: Boolean = false): Option<KProperty2<*, *, R>>

@JvmName(name = "findKPropertyMutable0")

inline fun <R> Collection<KMutableProperty0<*>>.findKProperty(name: String, ignoreCase: Boolean = false): Option<KMutableProperty0<R>>

@JvmName(name = "findKPropertyMutable1")

inline fun <R> Collection<KMutableProperty1<*, *>>.findKProperty(name: String, ignoreCase: Boolean = false): Option<KMutableProperty1<*, R>>

@JvmName(name = "findKPropertyMutable2")

inline fun <R> Collection<KMutableProperty2<*, *, *>>.findKProperty(name: String, ignoreCase: Boolean = false): Option<KMutableProperty2<*, *, R>>

getCast

fun <T : Any> Collection<*>.getCast(index: Int): Validated<Throwable, T>

ifNotEmpty

inline fun <T> Collection<T>?.ifNotEmpty(block: Collection<T>.() -> Unit): Collection<T>?

Invokes the given block if the receiver is not empty.

msg

@JvmName(name = "msgAudienceCollection")

infix fun Collection<ComponentLike>.msg(audience: Audience)

parse

fun Collection<String>.parse(): List<Component>