Enum Class FcCacheMetrics.Outcome

java.lang.Object

java.lang.Enum<FcCacheMetrics.Outcome>

org.frontcache.cache.FcCacheMetrics.Outcome

All Implemented Interfaces:

Serializable, Comparable<FcCacheMetrics.Outcome>, Constable

Enclosing class:

FcCacheMetrics

public static enum FcCacheMetrics.Outcome
extends Enum<FcCacheMetrics.Outcome>

Where a cache read was answered from, or that it was not.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HIT_L1	Served from the in-memory tier (L1, or the whole cache for the in-memory processor).
HIT_L2	Served from the on-disk tier (L2 - the Lucene index).
MISS	Not cached: the caller goes to the origin.

Method Summary

Modifier and Type	Method	Description
String	getResult()	hit or miss - the label the hit ratio is computed from.
String	getTier()	L1, L2, or none for a miss.
static FcCacheMetrics.Outcome	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FcCacheMetrics.Outcome[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HIT_L1

public static final FcCacheMetrics.Outcome HIT_L1

Served from the in-memory tier (L1, or the whole cache for the in-memory processor).

HIT_L2

public static final FcCacheMetrics.Outcome HIT_L2

Served from the on-disk tier (L2 - the Lucene index).

MISS

public static final FcCacheMetrics.Outcome MISS

Not cached: the caller goes to the origin.

Method Details

values

public static FcCacheMetrics.Outcome[] 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 FcCacheMetrics.Outcome 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

getResult

public String getResult()

hit or miss - the label the hit ratio is computed from.

getTier

public String getTier()

L1, L2, or none for a miss.