magoffin.matt.ma2.lucene
Enum IndexType

java.lang.Object
  java.lang.Enum<IndexType>
      magoffin.matt.ma2.lucene.IndexType

All Implemented Interfaces:

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

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

The types of indicies supported.

Version:

$Revision: 43 $ $Date: 2007-10-21 11:10:01 +1300 (Sun, 21 Oct 2007) $

Author:

Matt Magoffin (spamsqr@msqr.us)

Enum Constant Summary

ALBUM
The Album index type.

MEDIA_ITEM
The MediaItem index type.

USER
The User index type.

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

ALBUM

public static final IndexType ALBUM

The Album index type.

MEDIA_ITEM

public static final IndexType MEDIA_ITEM

The MediaItem index type.

USER

public static final IndexType USER

The User index type.

Method Detail

values

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

Returns:

an array containing the constants of this enum type, in the order they're 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