org.basex.index
Enum IndexType

java.lang.Object
  extended by java.lang.Enum<IndexType>
      extended by org.basex.index.IndexType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<IndexType>

public enum IndexType
extends java.lang.Enum<IndexType>

This enumeration lists available index types.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Enum Constant Summary
ATTNAME
          Attribute names.
ATTRIBUTE
          Attribute index.
FULLTEXT
          Full-text index.
PATH
          Path index.
TAG
          Element names.
TEXT
          Text index.
 
Method Summary
static IndexType valueOf(java.lang.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

ATTNAME

public static final IndexType ATTNAME
Attribute names.


TAG

public static final IndexType TAG
Element names.


TEXT

public static final IndexType TEXT
Text index.


ATTRIBUTE

public static final IndexType ATTRIBUTE
Attribute index.


FULLTEXT

public static final IndexType FULLTEXT
Full-text index.


PATH

public static final IndexType PATH
Path 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(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null