com.exalead.searchapi.xmlv10.client

Enum Topic.State

java.lang.Object

java.lang.Enum<Topic.State>

com.exalead.searchapi.xmlv10.client.Topic.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Topic.State>

Enclosing interface:

Topic

public static enum Topic.State
extends java.lang.Enum<Topic.State>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISPLAYED State of a topic which is not currently used for a refinement or an exclusion.
EXCLUDED State of a topic which is used for an exclusion.
REFINED State of a topic which is used for a refinement.

Method Summary

Modifier and Type	Method and Description
static Topic.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Topic.State[]	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

DISPLAYED

public static final Topic.State DISPLAYED

State of a topic which is not currently used for a refinement or an exclusion. The id of this topic can used to refine the current search.

REFINED

public static final Topic.State REFINED

State of a topic which is used for a refinement. It means that all the hits returned have this topic.

EXCLUDED

public static final Topic.State EXCLUDED

State of a topic which is used for an exclusion. It means that all the hits of that have this topic term are excluded.

Method Detail

values

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

Returns:

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

valueOf

public static Topic.State 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