kord-extensions/dev.kordex.core.utils.collections/FixedLengthQueue

FixedLengthQueue

@Serializable(with = FixedLengthQueueSerializer::class)

class FixedLengthQueue<E>(val maxSize: Int) : Queue<E>

Fixed-length FIFO Queue implementation based on a MutableList.

Transparently adds data to the list in reverse (the queue's head is the end of the list), copying and reversing the list when retrieved via getAll.

If you need to be able to tell the difference between a null value and a missing value, consider using Kord's dev.kord.common.entity.optional.Optional as the element type.

Parameters

maxSize

Maximum number of elements in this queue.

Constructors

FixedLengthQueue

constructor(maxSize: Int)

Properties

maxSize

val maxSize: Int

size

open override val size: Int

Functions

add

open override fun add(element: E): Boolean

addAll

open override fun addAll(elements: Collection<E>): Boolean

clear

open override fun clear()

contains

open operator override fun contains(element: E): Boolean

containsAll

open override fun containsAll(elements: Collection<E>): Boolean

element

open override fun element(): E?

forEach

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

get

fun get(): E?

Retrieve the last element.

getAll

fun getAll(): List<E>

Returns a list of all elements in this queue, in pushed order (newest to oldest).

getFirst

fun getFirst(): E?

Retrieve the first element.

isEmpty

open override fun isEmpty(): Boolean

iterator

open operator override fun iterator(): MutableIterator<E>

offer

open override fun offer(element: E): Boolean

parallelStream

open fun parallelStream(): Stream<E>

peek

open override fun peek(): E?

poll

open override fun poll(): E?

pop

fun pop(): E?

Remove the last element and return it.

popFirst

fun popFirst(): E?

Remove the first element and return it.

push

fun push(element: E): Boolean

Add an element to the head of the queue, replacing the element at the tail if maxSize has been reached.

remove

open override fun remove(): E?

open override fun remove(element: E): Boolean

removeAll

open override fun removeAll(elements: Collection<E>): Boolean

removeIf

open fun removeIf(p0: Predicate<in E>): Boolean

retainAll

open override fun retainAll(elements: Collection<E>): Boolean

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>