fulmine.model.container
Enum IContainer.DataState

java.lang.Object
  java.lang.Enum<IContainer.DataState>
      fulmine.model.container.IContainer.DataState

All Implemented Interfaces:

Serializable, Comparable<IContainer.DataState>

Enclosing interface:

IContainer

public static enum IContainer.DataState
extends Enum<IContainer.DataState>

The enumeration of data states for an IContainer.

There are 2 data states

• LIVE - in this state, the data of the container is being updated (in real-time) and can be considered trustworthy.
• STALE - in this state, the data of the container is not being updated and should be considered untrustable.

A container is automatically 'live' when it is created and automatically 'stale' when it is destroyed. Application logic may also change the data state.

The data state is orthogonal to the life-cycle state of the container.

Author:

Ramon Servadei

Enum Constant Summary

LIVE
Enumerates the live data state.

STALE
Enumerates the stale data state.

Method Summary

static IContainer.DataState	fromOrdinal(int ordinal) Find the enum from its ordinal
static IContainer.DataState	valueOf(String name) Returns the enum constant of this type with the specified name.
static IContainer.DataState[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LIVE

public static final IContainer.DataState LIVE

Enumerates the live data state. The data in the container is up-to-date and trustworthy.

See Also:

IContainer.getDataState()

STALE

public static final IContainer.DataState STALE

Enumerates the stale data state. The data in the container is not being updated and is not trustworthy.

See Also:

IContainer.getDataState()

Method Detail

values

public static final IContainer.DataState[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(IContainer.DataState c : IContainer.DataState.values())
        System.out.println(c);

Returns:

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

valueOf

public static IContainer.DataState 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

fromOrdinal

public static IContainer.DataState fromOrdinal(int ordinal)

Find the enum from its ordinal

Parameters:

ordinal - the ordinal

Returns:

the enum for the ordinal

Throws:

IllegalArgumentException - if the ordinal does not match