com.endeca.itl.cas.api
Enum MetricType

java.lang.Object
  java.lang.Enum<MetricType>
      com.endeca.itl.cas.api.MetricType

All Implemented Interfaces:

Serializable, Comparable<MetricType>

public enum MetricType
extends Enum<MetricType>

Enumeration used to indicate the type of metric that is returned. This is used to annotate MetricId's, so that the appropriate type of metric object can be created for it.

Enum Constant Summary

COUNT
The metric represents a long that is used as a counter.

CRAWLMODE
The metric represents the crawl's mode

CRAWLSTATE
The metric represents the crawl's state

CRAWLSTOPCAUSE
The metric represents a cause for stopping the crawl

DATETIME
The metric represents a date

LONG
The metric represents a long

STRING
The metric represents a string

Method Summary

String	getDescription()
static MetricType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MetricType[]	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

LONG

public static final MetricType LONG

The metric represents a long

COUNT

public static final MetricType COUNT

The metric represents a long that is used as a counter. Counters start at zero and are incremented, while regular long properties are merely set.

STRING

public static final MetricType STRING

The metric represents a string

DATETIME

public static final MetricType DATETIME

The metric represents a date

CRAWLMODE

public static final MetricType CRAWLMODE

The metric represents the crawl's mode

CRAWLSTATE

public static final MetricType CRAWLSTATE

The metric represents the crawl's state

CRAWLSTOPCAUSE

public static final MetricType CRAWLSTOPCAUSE

The metric represents a cause for stopping the crawl

Method Detail

values

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

Returns:

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

valueOf

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

getDescription

public String getDescription()