Package com.yahoo.searchdefinition.document

Enum RankType

java.lang.Object

java.lang.Enum<RankType>

com.yahoo.searchdefinition.document.RankType

All Implemented Interfaces:

Serializable, Comparable<RankType>

public enum RankType
extends Enum<RankType>

The rank type of a field. For now this is just a container of a string name. This class is immutable.

Author:

bratseth

Enum Constant Summary

Enum Constants

Enum Constant	Description
ABOUT
DEFAULT	implicit* default: No type has been set.
EMPTY
IDENTITY
TAGS

Method Summary

Modifier and Type	Method	Description
static RankType	fromString(String rankTypeName)	Returns the rank type from a string, regardless of its case.
String	toString()
static RankType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RankType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEFAULT

public static final RankType DEFAULT

implicit* default: No type has been set.

IDENTITY

public static final RankType IDENTITY

ABOUT

public static final RankType ABOUT

TAGS

public static final RankType TAGS

EMPTY

public static final RankType EMPTY

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<RankType>

fromString

public static RankType fromString(String rankTypeName)

Returns the rank type from a string, regardless of its case.

Parameters:

rankTypeName - a rank type name in any casing

Returns:

the rank type found

Throws:

IllegalArgumentException - if not found