Package com.apple.foundationdb.record.metadata.expressions

Enum KeyExpression.FanType

java.lang.Object

java.lang.Enum<KeyExpression.FanType>

com.apple.foundationdb.record.metadata.expressions.KeyExpression.FanType

All Implemented Interfaces:

Serializable, Comparable<KeyExpression.FanType>

Enclosing interface:

KeyExpression

public static enum KeyExpression.FanType
extends Enum<KeyExpression.FanType>

How should repeated fields be handled. These names don't technically meet our naming convention but changing them is a lot of work because of all of the string constants.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Concatenate	Convert a repeated field into a single list.
FanOut	Create an index value for each value of the field.
None	Nothing, only allowed with scalar fields.

Method Summary

Modifier and Type	Method	Description
static KeyExpression.FanType	valueOf(RecordMetaDataProto.Field.FanType fanType)	Returns the enum constant of this type with the specified name.
static KeyExpression.FanType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KeyExpression.FanType[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Concatenate

public static final KeyExpression.FanType Concatenate

Convert a repeated field into a single list. This does not cause the number of index values to increase.

FanOut

public static final KeyExpression.FanType FanOut

Create an index value for each value of the field.

None

public static final KeyExpression.FanType None

Nothing, only allowed with scalar fields.

Method Detail

values

public static KeyExpression.FanType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KeyExpression.FanType c : KeyExpression.FanType.values())
    System.out.println(c);

Returns:

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

valueOf

public static KeyExpression.FanType 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

valueOf

public static KeyExpression.FanType valueOf(RecordMetaDataProto.Field.FanType fanType)
                                     throws KeyExpression.DeserializationException

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:

fanType - 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

KeyExpression.DeserializationException