com.caplin.streamlink

Enum SubscriptionStatusType

java.lang.Object

java.lang.Enum<SubscriptionStatusType>

com.caplin.streamlink.SubscriptionStatusType

All Implemented Interfaces:

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

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

Enumeration that defines the status of a subject.

The SubscriptionStatusType will be provided by calling getStatus() on a SubscriptionStatusEvent.

Enum Constant Summary

Enum Constants

Enum Constant and Description
STATUS_INFO An informational message about the subject (usually sent by the DataSource).
STATUS_LIMITED One of the sources of data for the subject is not available.
STATUS_OK The data associated with the subject is correct and up-to-date.
STATUS_STALE The subject's data may not be correct and up-to-date.

Method Summary

Methods

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

STATUS_OK

public static final SubscriptionStatusType STATUS_OK

The data associated with the subject is correct and up-to-date.

STATUS_LIMITED

public static final SubscriptionStatusType STATUS_LIMITED

One of the sources of data for the subject is not available. This may affect the subject's data.

STATUS_STALE

public static final SubscriptionStatusType STATUS_STALE

The subject's data may not be correct and up-to-date.

STATUS_INFO

public static final SubscriptionStatusType STATUS_INFO

An informational message about the subject (usually sent by the DataSource).

Method Detail

values

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

Returns:

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

valueOf

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