org.eclipse.smila.search.index
Enum Usage

java.lang.Object
  java.lang.Enum<Usage>
      org.eclipse.smila.search.index.Usage

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Usage>

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

Enum defining the current index state.

Author:

August Georg Schmidt (BROX)

Enum Constant Summary

Multi
Multi user mode.

None
No usage.

Single
Single user mode.

Method Summary

static Usage	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Usage[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

None

public static final Usage None

No usage.

Single

public static final Usage Single

Single user mode.

Multi

public static final Usage Multi

Multi user mode.

Method Detail

values

public static final Usage[] values()

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

for(Usage c : Usage.values())
        System.out.println(c);

Returns:

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

valueOf

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