com.diffusiondata.gateway.framework

Enum ServiceState

java.lang.Object

java.lang.Enum<ServiceState>

com.diffusiondata.gateway.framework.ServiceState

All Implemented Interfaces:

Serializable, Comparable<ServiceState>

public enum ServiceState
extends Enum<ServiceState>

Indicates the current state of a service.

A SourceHandler or HybridHandler can only publish updates, and a SinkHandler or HybridHandler will only receive updates when the service state is ACTIVE.

Author:

DiffusionData Limited

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE This is the state when a service has been successfully started or resumed.
INITIAL This is the initial state of a service before the ServiceHandler.start() method has been called.
PAUSED This is the state when a service has been paused by user request, the framework has become disconnected from the Diffusion, or the service handler has reported an error.
STOPPED This is the state when the application has been stopped or the service has been removed.

Method Summary

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

INITIAL

public static final ServiceState INITIAL

This is the initial state of a service before the ServiceHandler.start() method has been called.

ACTIVE

public static final ServiceState ACTIVE

This is the state when a service has been successfully started or resumed.

PAUSED

public static final ServiceState PAUSED

This is the state when a service has been paused by user request, the framework has become disconnected from the Diffusion, or the service handler has reported an error.

STOPPED

public static final ServiceState STOPPED

This is the state when the application has been stopped or the service has been removed.

This is the terminal state for a service. It can no longer be started or resumed.

Method Detail

values

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

Returns:

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

valueOf

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