Package velox.api.layer1.messages.plugin

Enum Class AvailablePluginsRequest.CacheMode

java.lang.Object

java.lang.Enum<AvailablePluginsRequest.CacheMode>

velox.api.layer1.messages.plugin.AvailablePluginsRequest.CacheMode

All Implemented Interfaces:

Serializable, Comparable<AvailablePluginsRequest.CacheMode>, Constable

Enclosing class:

AvailablePluginsRequest

public static enum AvailablePluginsRequest.CacheMode
extends Enum<AvailablePluginsRequest.CacheMode>

Determines how plugin catalog information is retrieved.

This setting has no effect when AvailablePluginsRequest.TargetGroup.ACTIVE_ALL is requested.

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
FRESH	Retrieves current plugin information from the server and replaces the cached information.
FRESH_IF_NO_CACHE	Uses cached plugin information when available.
FROM_CACHE	Uses cached plugin information only and does not contact the server.

Method Summary

Modifier and Type	Method	Description
static AvailablePluginsRequest.CacheMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AvailablePluginsRequest.CacheMode[]	values()	Returns an array containing the constants of this enum class, 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

FROM_CACHE

public static final AvailablePluginsRequest.CacheMode FROM_CACHE

Uses cached plugin information only and does not contact the server. If the cache is empty, the request succeeds with an empty list of qualifiers.

FRESH_IF_NO_CACHE

public static final AvailablePluginsRequest.CacheMode FRESH_IF_NO_CACHE

Uses cached plugin information when available. If the cache is empty, retrieves the information from the server and stores it in the cache.

FRESH

public static final AvailablePluginsRequest.CacheMode FRESH

Retrieves current plugin information from the server and replaces the cached information.

Method Details

values

public static AvailablePluginsRequest.CacheMode[] 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 AvailablePluginsRequest.CacheMode 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