com.caplin.streamlink

Enum ServiceStatus

java.lang.Object

java.lang.Enum<ServiceStatus>

com.caplin.streamlink.ServiceStatus

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ServiceStatus>

public enum ServiceStatus
extends java.lang.Enum<ServiceStatus>

Enumeration that defines the status of a Service.

The ServiceStatus will be provided by calling getServiceStatus on a ServiceStatusEvent.

The three states that are possible for a Liberator data service are:

• OK - All of the data sources that make up the service are up.
• Down - One or more required data sources for the service are down.
• Limited - One or more non-required data sources for the service are down.

See Also:

ServiceStatusEvent

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN Indicates that a service is down, which means that at least one of the required sources defined for the service are down.
LIMITED Indicates that a service is limited, which means that at least one of the non required sources defined for the service are down (but all of the required sources are up).
OK Indicates that the service is OK, which means that all the required and non required sources defined for the service are up.

Method Summary

Methods

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

DOWN

public static final ServiceStatus DOWN

Indicates that a service is down, which means that at least one of the required sources defined for the service are down.

LIMITED

public static final ServiceStatus LIMITED

Indicates that a service is limited, which means that at least one of the non required sources defined for the service are down (but all of the required sources are up).

OK

public static final ServiceStatus OK

Indicates that the service is OK, which means that all the required and non required sources defined for the service are up.

Method Detail

values

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

Returns:

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

valueOf

public static ServiceStatus valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null