Package org.codelibs.fess.api

Enum Class BaseApiManager.FormatType

java.lang.Object

java.lang.Enum<BaseApiManager.FormatType>

org.codelibs.fess.api.BaseApiManager.FormatType

All Implemented Interfaces:

Serializable, Comparable<BaseApiManager.FormatType>, Constable

Enclosing class:

BaseApiManager

protected static enum BaseApiManager.FormatType
extends Enum<BaseApiManager.FormatType>

Enumeration of supported API format types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAVORITE	Favorite API format.
FAVORITES	Favorites API format.
LABEL	Label API format.
OTHER	Other API format.
PING	Ping API format.
POPULARWORD	Popular word API format.
SCROLL	Scroll API format.
SEARCH	Search API format.
SUGGEST	Suggest API format.

Method Summary

Modifier and Type	Method	Description
static BaseApiManager.FormatType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BaseApiManager.FormatType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SEARCH

public static final BaseApiManager.FormatType SEARCH

Search API format.

LABEL

public static final BaseApiManager.FormatType LABEL

Label API format.

POPULARWORD

public static final BaseApiManager.FormatType POPULARWORD

Popular word API format.

FAVORITE

public static final BaseApiManager.FormatType FAVORITE

Favorite API format.

FAVORITES

public static final BaseApiManager.FormatType FAVORITES

Favorites API format.

PING

public static final BaseApiManager.FormatType PING

Ping API format.

SCROLL

public static final BaseApiManager.FormatType SCROLL

Scroll API format.

SUGGEST

public static final BaseApiManager.FormatType SUGGEST

Suggest API format.

OTHER

public static final BaseApiManager.FormatType OTHER

Other API format.

Method Details

values

public static BaseApiManager.FormatType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BaseApiManager.FormatType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null