core/org.gnit.lucenekmp.jdkport/NullableKeyValueHolder

NullableKeyValueHolder

class NullableKeyValueHolder<K, V> : MutableMap.MutableEntry<K, V>

An immutable container for a key and a value, both of which are nullable.

This is a {@docRoot}/java.base/java/lang/doc-files/ValueBased.html class; programmers should treat instances that are .equals as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail.

Parameters

the value type

Constructors

NullableKeyValueHolder

constructor(k: K, v: V)

Constructs a NullableKeyValueHolder.

constructor(entry: MutableMap.MutableEntry<K, V>)

Constructs a NullableKeyValueHolder from a Map.Entry. No need for an idempotent copy at this time.

Properties

key

open override val key: K

Gets the key from this holder.

value

open override val value: V

Gets the value from this holder.

Functions

equals

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

Compares the specified object with this entry for equality. Returns true if the given object is also a map entry and the two entries' keys and values are equal.

hashCode

open override fun hashCode(): Int

Returns the hash code value for this map entry. The hash code is key.hashCode() ^ value.hashCode().

setValue

open override fun setValue(value: V): V

Throws UnsupportedOperationException.

toString

open override fun toString(): String

Returns a String representation of this map entry. This implementation returns the string representation of this entry's key followed by the equals character ("=") followed by the string representation of this entry's value.