Module org.cruk.clarity.api

Package org.cruk.clarity.api

Enum StatefulOverride

java.lang.Object

java.lang.Enum<StatefulOverride>

org.cruk.clarity.api.StatefulOverride

All Implemented Interfaces:

Serializable, Comparable<StatefulOverride>, java.lang.constant.Constable

public enum StatefulOverride
extends Enum<StatefulOverride>

Enumeration of the ways to override the normal behaviour of the API and the cache to get specific versions of stateful entities.

Since:

2.24.8

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
EXACT	Fetch the exact version of a stateful entity, the version as specified by its state parameter.
LATEST	Fetch the latest version of the stateful entity.

Method Summary

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

LATEST

public static final StatefulOverride LATEST

Fetch the latest version of the stateful entity. This retrieves the entity with any state parameter removed from the URI. It does not look in the cache for the entity, always calling through to the Clarity API. The entity returned is cached.

EXACT

public static final StatefulOverride EXACT

Fetch the exact version of a stateful entity, the version as specified by its state parameter. Will be fetched from the cache if the cache happens to contain this exact version, otherwise it will go to the Clarity API. The returned entity may be stored in the cache according to the usual cache rules. If there is a newer version of the entity in the cache already, that will be ignored.

Method Details

values

public static StatefulOverride[] values()

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

Returns:

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

valueOf

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