Package com.apple.foundationdb.async.hnsw

Enum NodeKind

java.lang.Object

java.lang.Enum<NodeKind>

com.apple.foundationdb.async.hnsw.NodeKind

All Implemented Interfaces:

Serializable, Comparable<NodeKind>, java.lang.constant.Constable

public enum NodeKind
extends Enum<NodeKind>

Represents the different kinds of nodes, each associated with a unique byte value for serialization and deserialization.

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
COMPACT	Compact node.
INLINING	Inlining node.

Method Summary

Modifier and Type	Method	Description
byte	getSerialized()	Gets the serialized byte value.
static NodeKind	valueOf(String name)	Returns the enum constant of this type with the specified name.
static NodeKind[]	values()	Returns an array containing the constants of this enum type, 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

COMPACT

public static final NodeKind COMPACT

Compact node. Serialization and deserialization is implemented in CompactNode.

Compact nodes store their own vector and their neighbors-list only contain the primary key for each neighbor.

INLINING

public static final NodeKind INLINING

Inlining node. Serialization and deserialization is implemented in InliningNode.

Inlining nodes do not store their own vector and their neighbors-list contain the both the primary key and the neighbor vector for each neighbor. Each neighbor is stored in its own key/value pair.

Method Details

values

public static NodeKind[] values()

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

Returns:

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

valueOf

public static NodeKind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getSerialized

public byte getSerialized()

Gets the serialized byte value.

Returns:

the serialized byte value