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

ExpirationMapValue

@ApiStatus.Experimental

@ApiStatus.AvailableSince(value = "5.0.0")

data class ExpirationMapValue<K, V> : Expireable<V>

A representation of a value in an ExpirationMap. This element holds the value itself, the startTime, the expireIn time from the startTime, and its onExpire callback.

Parameters

V

The type of value in the map.

Functions

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

open override fun getDelay(unit: TimeUnit): Long

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

The Duration of time until the value expires.

Properties

open override val expireIn: Duration

How long from the current time the element will expire.

val onExpire: ExpirationMapCallback<K, V>?

The ExpirationMapCallback which might be executed when the element expires.

open override val startTime: Instant

The time the element was created/added.

open override val value: V

The value.