Package com.apple.foundationdb.record

Enum PlanHashable.PlanHashMode

java.lang.Object

java.lang.Enum<PlanHashable.PlanHashMode>

com.apple.foundationdb.record.PlanHashable.PlanHashMode

All Implemented Interfaces:

Serializable, Comparable<PlanHashable.PlanHashMode>, java.lang.constant.Constable

Enclosing interface:

PlanHashable

public static enum PlanHashable.PlanHashMode
extends Enum<PlanHashable.PlanHashMode>

A mode for a plan hash which captures both kind and version. One reason we use an enum here is to force implementors to declare a new version, and to avoid greater than/less than comparisons. In reality (the future will tell), we only want at most two versions to not be deprecated.

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
VC0
VC1	Changes contained are: ConstantObjectValue hashes without index .
VL0

Method Summary

Modifier and Type	Method	Description
PlanHashable.PlanHashKind	getKind()	Get the plan hash kind associated with this mode.
int	getNumericVersion()	Returns a numeric version.
static PlanHashable.PlanHashMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PlanHashable.PlanHashMode[]	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

VL0

public static final PlanHashable.PlanHashMode VL0

VC0

public static final PlanHashable.PlanHashMode VC0

VC1

public static final PlanHashable.PlanHashMode VC1

Changes contained are:

• ConstantObjectValue hashes without index

.

Method Details

values

public static PlanHashable.PlanHashMode[] 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 PlanHashable.PlanHashMode 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

getKind

public PlanHashable.PlanHashKind getKind()

Get the plan hash kind associated with this mode.

Returns:

the plan hash kind

getNumericVersion

public int getNumericVersion()

Returns a numeric version. Do not use this information if you can. This method should strictly be used when this method is serialized, etc. However, it should not be used to switch on different plan hash versions.

Returns:

a numerical version