kone.collections/dev.lounres.kone.collections

Package-level declarations

Types

CapacityOverflowException

class CapacityOverflowException(message: String = "Overflow of collection with fixed capacity") : RuntimeException

Represents exception that is thrown when user tries to overflow a data structure with fixed capacity.

DelicateCollectionsInheritanceAPI

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class DelicateCollectionsInheritanceAPI

DetachedNodeException

class DetachedNodeException(message: String = "The node is already detached, so the operation is undefined in that case.") : IllegalStateException

Represents exception that is thrown when user tries to change detached node's properties.

Disposable

interface Disposable

Represents disposable structure that is optimised for GC when is disposed.

DisposedInstanceException

class DisposedInstanceException(message: String = "The object is already disposed, so the operation is undefined in that case.") : IllegalStateException

Represents exception that is thrown when user tries to use disposed object.

ElementAccessInEmptyCollectionException

class ElementAccessInEmptyCollectionException(message: String = "Cannot access the element of the empty collection") : NoSuchElementException

EmptyDequeAccessException

class EmptyDequeAccessException(message: String = "There is no elements in empty deque") : NoSuchElementException

NoCorrespondingNodeException

class NoCorrespondingNodeException(message: String = "There is no corresponding node") : NoSuchElementException

Represents exception that is thrown when user tries to get some nodded data structure's node that matches given conditions but there is no such element.

NoElementMatchingThePredicateException

class NoElementMatchingThePredicateException(message: String = "There is no element matching the predicate.") : NoSuchElementException

Represents exception that is thrown when user tries to get element that matches the provided predicate but there is no such element.

NoFollowingElementInIteratorException

class NoFollowingElementInIteratorException(message: String = "There is no following element in the iterator") : NoSuchElementException

Represents exception that is thrown when user tries to get, set, remove, or bypass the next or the previous non-existent element.

NoMatchingKeyException

class NoMatchingKeyException(message: String = "There is no value for requested key") : NoSuchElementException

Represents exception that is thrown when user tries to get some KoneMap instance's element that matches the provided key but there is no such element.

Properties

NO_CORRESPONDING_SET_NODE_MESSAGE

const val NO_CORRESPONDING_SET_NODE_MESSAGE: String

Functions

accessRootOfEmptyHeapException

fun accessRootOfEmptyHeapException(): Nothing

capacityOverflowException

fun capacityOverflowException(capacity: UInt): Nothing

Throws CapacityOverflowException with message including provided capacity.

detachedNodeException

fun detachedNodeException(message: String = "The node is already detached, so the operation is undefined in that case."): Nothing

Throws DetachedNodeException with the provided message describing that the node is already detached and doesn't support used operation.

disposedInstanceException

fun disposedInstanceException(message: String = "The object is already disposed, so the operation is undefined in that case."): Nothing

Throws DisposedInstanceException with the provided message describing that the object is already disposed and doesn't support used operation.

emptyDequeAccessException

fun emptyDequeAccessException(): Nothing

indexOutOfBoundsException

fun indexOutOfBoundsException(index: UInt, size: UInt): Nothing

Throws IndexOutOfBoundsException with message including provided index and size.

noCorrespondingNodeException

fun noCorrespondingNodeException(message: String = "There is no corresponding node"): Nothing

Throws NoCorrespondingNodeException with provided message.

noCorrespondingSetNodeException

fun noCorrespondingSetNodeException(): Nothing

noElementMatchingThePredicateException

fun noElementMatchingThePredicateException(message: String = "There is no element matching the predicate."): Nothing

Throws NoElementMatchingThePredicateException with the provided message describing that there is no element matching the predicate.

noMatchingKeyException

fun noMatchingKeyException(key: Any?): Nothing

Throws NoMatchingKeyException with message including provided key.

noNextElementInIteratorException

fun noNextElementInIteratorException(message: String = "There is no next element in the iterator"): Nothing

Throws NoFollowingElementInIteratorException with the provided message describing that there is no next element.

noPreviousElementInIteratorException

fun noPreviousElementInIteratorException(message: String = "There is no previous element in the iterator"): Nothing

Throws NoFollowingElementInIteratorException with the provided message describing that there is no previous element.