Package com.apple.foundationdb.async.hnsw

Enum Class Cardinality

java.lang.Object

java.lang.Enum<Cardinality>

com.apple.foundationdb.async.hnsw.Cardinality

All Implemented Interfaces:

Serializable, Comparable<Cardinality>, Constable

public enum Cardinality
extends Enum<Cardinality>

A coarse classification of how many nodes live on a layer of the graph. It is deliberately coarse — only the cases EMPTY, SINGLE and MULTIPLE are distinguished — so that the underlying scan can stop reading after the second node and need not count an entire layer.

See Also:

• HNSW.cardinality(ReadTransaction)

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMPTY	The layer contains no nodes.
MULTIPLE	The layer contains two or more nodes.
SINGLE	The layer contains exactly one node.

Method Summary

Modifier and Type	Method	Description
static Cardinality	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Cardinality[]	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

Enum Constant Details

EMPTY

public static final Cardinality EMPTY

The layer contains no nodes.

SINGLE

public static final Cardinality SINGLE

The layer contains exactly one node.

MULTIPLE

public static final Cardinality MULTIPLE

The layer contains two or more nodes.

Method Details

values

public static Cardinality[] 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 Cardinality 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