javax.cache
Enum CacheStatus

java.lang.Object
  java.lang.Enum<CacheStatus>
      javax.cache.CacheStatus

All Implemented Interfaces:

Serializable, Comparable<CacheStatus>

public enum CacheStatus
extends Enum<CacheStatus>

Indicates the status in it's lifecycle of a resource. todo change name back to Status

Since:

1.0

Author:

Greg Luck

Enum Constant Summary

STARTED
The resoure has been started and is ready for service.

STARTING
The resource is in the process of starting

STOPPED
The resource has been stopped.

STOPPING
The resource is in the process of stopping.

UNINITIALISED
The resource has been created but not yet initialised.

Method Summary

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

UNINITIALISED

public static final CacheStatus UNINITIALISED

The resource has been created but not yet initialised. It cannot be used.

STARTING

public static final CacheStatus STARTING

The resource is in the process of starting

STARTED

public static final CacheStatus STARTED

The resoure has been started and is ready for service.

STOPPING

public static final CacheStatus STOPPING

The resource is in the process of stopping.

STOPPED

public static final CacheStatus STOPPED

The resource has been stopped. It can no longer service requests.

Method Detail

values

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

Returns:

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

valueOf

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