core/org.gnit.lucenekmp.jdkport/TreeMap/Companion/KeySet

KeySet

class KeySet<E> : AbstractSet<E> , NavigableSet<E>

Properties

first

open override val first: E?

last

open override val last: E?

size

open override var size: Int

Functions

add

open override fun add(element: E): Boolean

addAll

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

addFirst

open override fun addFirst(e: E)

Throws UnsupportedOperationException. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.

addLast

open override fun addLast(e: E)

Throws UnsupportedOperationException. The encounter order induced by this set's comparison method determines the position of elements, so explicit positioning is not supported.

ceiling

open override fun ceiling(e: E): E?

Returns the least element in this set greater than or equal to the given element, or null if there is no such element.

clear

open override fun clear()

comparator

open override fun comparator(): Comparator<E>?

Returns the comparator used to order the elements in this set, or null if this set uses the natural ordering of its elements.

contains

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

containsAll

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

descendingIterator

open override fun descendingIterator(): MutableIterator<E>

Returns an iterator over the elements in this set, in descending order. Equivalent in effect to descendingSet().iterator().

descendingSet

open override fun descendingSet(): NavigableSet<E>

Returns a reverse order view of the elements contained in this set. The descending set is backed by this set, so changes to the set are reflected in the descending set, and vice-versa. If either set is modified while an iteration over either set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined.

equals

open operator override fun equals(other: Any?): Boolean

first

open override fun first(): E?

Returns the first (lowest) element currently in this set.

floor

open override fun floor(e: E): E?

Returns the greatest element in this set less than or equal to the given element, or null if there is no such element.

hashCode

open override fun hashCode(): Int

headSet

open override fun headSet(toElement: E): SortedSet<E>

{@inheritDoc}

open override fun headSet(toElement: E, inclusive: Boolean): NavigableSet<E>

Returns a view of the portion of this set whose elements are less than (or equal to, if inclusive is true) toElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

higher

open override fun higher(e: E): E?

Returns the least element in this set strictly greater than the given element, or null if there is no such element.

isEmpty

open override fun isEmpty(): Boolean

iterator

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

Returns an iterator over the elements in this set, in ascending order.

last

open override fun last(): E?

Returns the last (highest) element currently in this set.

lower

open override fun lower(e: E): E?

Returns the greatest element in this set strictly less than the given element, or null if there is no such element.

pollFirst

open override fun pollFirst(): E?

Retrieves and removes the first (lowest) element, or returns null if this set is empty (optional operation).

pollLast

open override fun pollLast(): E?

Retrieves and removes the last (highest) element, or returns null if this set is empty (optional operation).

remove

open override fun remove(o: E): Boolean

removeAll

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

removeFirst

open override fun removeFirst(): E?

{@inheritDoc}

removeLast

open override fun removeLast(): E?

{@inheritDoc}

retainAll

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

reversed

open override fun reversed(): NavigableSet<E>

{@inheritDoc}

subSet

open override fun subSet(fromElement: E, toElement: E): SortedSet<E>

{@inheritDoc}

open override fun subSet(fromElement: E, fromInclusive: Boolean, toElement: E, toInclusive: Boolean): NavigableSet<E>

Returns a view of the portion of this set whose elements range from fromElement to toElement. If fromElement and toElement are equal, the returned set is empty unless fromInclusive and toInclusive are both true. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

tailSet

open override fun tailSet(fromElement: E): SortedSet<E>

{@inheritDoc}

open override fun tailSet(fromElement: E, inclusive: Boolean): NavigableSet<E>

Returns a view of the portion of this set whose elements are greater than (or equal to, if inclusive is true) fromElement. The returned set is backed by this set, so changes in the returned set are reflected in this set, and vice-versa. The returned set supports all optional set operations that this set supports.

toString

open override fun toString(): String