com.apple.foundationdb.record

Enum EndpointType

java.lang.Object

java.lang.Enum<EndpointType>

com.apple.foundationdb.record.EndpointType

All Implemented Interfaces:

Serializable, Comparable<EndpointType>

@API(value=MAINTAINED)
public enum EndpointType
extends Enum<EndpointType>

The type of one of the endpoints of a TupleRange.

The basic types are inclusive (range includes endpoint Tuple value) and exclusive (range does not include endpoint Tuple). Special types denote the start and end of the whole subspace (for which the endpoint Tuple does not matter). There is also a special type for the range of values where a string element of a Tuple begins with a given string.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTINUATION
PREFIX_STRING
RANGE_EXCLUSIVE
RANGE_INCLUSIVE
TREE_END
TREE_START

Method Summary

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

TREE_START

public static final EndpointType TREE_START

TREE_END

public static final EndpointType TREE_END

RANGE_INCLUSIVE

public static final EndpointType RANGE_INCLUSIVE

RANGE_EXCLUSIVE

public static final EndpointType RANGE_EXCLUSIVE

PREFIX_STRING

public static final EndpointType PREFIX_STRING

CONTINUATION

public static final EndpointType CONTINUATION

Method Detail

values

public static EndpointType[] 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 (EndpointType c : EndpointType.values())
    System.out.println(c);

Returns:

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

valueOf

public static EndpointType 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

toString

@Nonnull
public String toString(boolean high)