Package io.deephaven.kv

Enum Class KeyValuesCollection.Empty

java.lang.Object

java.lang.Enum<KeyValuesCollection.Empty>

io.deephaven.kv.KeyValuesCollection.Empty

All Implemented Interfaces:

KeyValuesCollection, Serializable, Comparable<KeyValuesCollection.Empty>, Constable

Enclosing interface:

KeyValuesCollection

public static enum KeyValuesCollection.Empty
extends Enum<KeyValuesCollection.Empty>
implements KeyValuesCollection

An empty key values collection

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface io.deephaven.kv.KeyValuesCollection

KeyValuesCollection.Empty

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
KeyValuesCollection	asImmutable()	Returns an immutable version of this.
Map<KeyPath,KeyValue>	asMap()	Return an unmodifiable map representing this collection.
static KeyValuesCollection.Empty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KeyValuesCollection.Empty[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.deephaven.kv.KeyValuesCollection

containsKey, get, isEmpty, keys, keyValues

Enum Constant Details

INSTANCE

public static final KeyValuesCollection.Empty INSTANCE

Method Details

values

public static KeyValuesCollection.Empty[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static KeyValuesCollection.Empty valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

asImmutable

public KeyValuesCollection asImmutable()

Description copied from interface: KeyValuesCollection

Returns an immutable version of this. May return this if it is immutable. Ensures that the caller can keep around their own immutable version.

Specified by:

asImmutable in interface KeyValuesCollection

Returns:

an immutable version of this

asMap

public Map<KeyPath,KeyValue> asMap()

Description copied from interface: KeyValuesCollection

Return an unmodifiable map representing this collection.

Note: it is not necessarily the case that this map is immutable. If an immutable map is needed, use asImmutable().asMap().

Specified by:

asMap in interface KeyValuesCollection

Returns:

the unmodifiable map