Package net.sf.eBus.feed.historic

Enum EHistoricSubscribeFeed.HistoricFeedState

java.lang.Object

java.lang.Enum<EHistoricSubscribeFeed.HistoricFeedState>

net.sf.eBus.feed.historic.EHistoricSubscribeFeed.HistoricFeedState

All Implemented Interfaces:

Serializable, Comparable<EHistoricSubscribeFeed.HistoricFeedState>

Enclosing class:

EHistoricSubscribeFeed

public static enum EHistoricSubscribeFeed.HistoricFeedState
extends Enum<EHistoricSubscribeFeed.HistoricFeedState>

Enumerates historic subscribe feed states.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DONE_ERROR	Historic subscribe feed is done due to an error.
DONE_SUCCESS	Historic subscribe feed successfully finished with both past and live notification messages.
FEED_OPEN	Historic subscribe feed is open but not yet subscribed to notifications.
HISTORIC_NOTIFICATIONS	Feed is collecting past notification message.
LIVE_NOTIFICATIONS	Feed has collected past notifications and is now processing live notification messages.

Method Summary

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

FEED_OPEN

public static final EHistoricSubscribeFeed.HistoricFeedState FEED_OPEN

Historic subscribe feed is open but not yet subscribed to notifications.

HISTORIC_NOTIFICATIONS

public static final EHistoricSubscribeFeed.HistoricFeedState HISTORIC_NOTIFICATIONS

Feed is collecting past notification message.

LIVE_NOTIFICATIONS

public static final EHistoricSubscribeFeed.HistoricFeedState LIVE_NOTIFICATIONS

Feed has collected past notifications and is now processing live notification messages.

DONE_SUCCESS

public static final EHistoricSubscribeFeed.HistoricFeedState DONE_SUCCESS

Historic subscribe feed successfully finished with both past and live notification messages. If end time location is EHistoricSubscribeFeed.TimeLocation.ON_GOING, the feed will never reach this done state.

DONE_ERROR

public static final EHistoricSubscribeFeed.HistoricFeedState DONE_ERROR

Historic subscribe feed is done due to an error. The exception causing this failure may be retrieved by calling .

Method Detail

values

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

Returns:

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

valueOf

public static EHistoricSubscribeFeed.HistoricFeedState 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