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

ExpirationNode

@ApiStatus.Experimental

@ApiStatus.AvailableSince(value = "5.0.0")

data class ExpirationNode<E> : Expireable<E>

A representation of an element in an ExpirationCollection. This element holds the element itself, the time it was added, and the time it will expire, and its callback. This also acts as a node in a linked list.

Parameters

The type of element in the collection.

Functions

compareTo

open operator override fun compareTo(other: Delayed?): Int

getDelay

open override fun getDelay(unit: TimeUnit): Long

remainingTime

open fun remainingTime(current: Instant? = null): Duration

The Duration of time until the value expires.

Properties

expireIn

open override val expireIn: Duration

How long from the current time the element will expire.

var next: ExpirationNode<E>? = null

The next node in the linked list.

onExpire

val onExpire: ExpirationCallback<E>?

The ExpirationCallback which might be executed when the element expires.

var previous: ExpirationNode<E>? = null

The previous node in the linked list.

startTime

open override val startTime: Instant

The time the element was created/added.

value

open override val value: E

The element.