com.basho.riak.client.core.query.indexes

Enum IndexType

java.lang.Object

java.lang.Enum<IndexType>

com.basho.riak.client.core.query.indexes.IndexType

All Implemented Interfaces:

Serializable, Comparable<IndexType>

public enum IndexType
extends Enum<IndexType>

Enum that encapsulates the suffix used to determine and index type in Riak.

There are two types of Secondary Indexes (2i) in Riak; "Integer" and "Binary". The current server API distinguishes between them via a suffix ("_int" and "_bin" respectively).

Since:

2.0

Author:

Brian Roach

See Also:

RiakIndex

Enum Constant Summary

Enum Constants

Enum Constant and Description
BIN Encapsulates the "_bin" suffix for Riak index names.
BUCKET Used for the special $bucket index
INT Encapsulates the "_int" suffix for Riak index names.
KEY Used for the special $key index

Method Summary

Modifier and Type	Method and Description
String	suffix() Returns the suffix for this type.
static IndexType	typeFromFullname(String fullname) Returns the index type from its fully qualified name
static IndexType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IndexType[]	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

INT

public static final IndexType INT

Encapsulates the "_int" suffix for Riak index names.

BIN

public static final IndexType BIN

Encapsulates the "_bin" suffix for Riak index names.

BUCKET

public static final IndexType BUCKET

Used for the special $bucket index

KEY

public static final IndexType KEY

Used for the special $key index

Method Detail

values

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

Returns:

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

valueOf

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

suffix

public String suffix()

Returns the suffix for this type.

Returns:

a String containing the suffix for this index type.

typeFromFullname

public static IndexType typeFromFullname(String fullname)

Returns the index type from its fully qualified name

There are two types of Secondary Indexes (2i) in Riak; "Integer" and "Binary". The current server API distinguishes between them via a suffix (_int and _bin respectively). This method takes a "fully qualified" 2i name (e.g. "my_index_int") and returns an enum that represents the type.

Parameters:

fullname - a "fully qualified" 2i name ending with the suffix "_int" or "_bin"

Returns:

the IndexType

Throws:

IllegalArgumentException - if the supplied index name does not have a valid suffix.