com.tibco.as.space.browser

Enum EventBrowserDef.TimeScope

java.lang.Object

java.lang.Enum<EventBrowserDef.TimeScope>

com.tibco.as.space.browser.EventBrowserDef.TimeScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EventBrowserDef.TimeScope>

Enclosing class:

EventBrowserDef

public static enum EventBrowserDef.TimeScope
extends java.lang.Enum<EventBrowserDef.TimeScope>

Enumeration of the possible ways to browse for events in a Space based upon the time at which the entries, for which the events occur, were stored in the Space relative to the EventBrowser creation time.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL The EventBrowser iterates through events for all of the entries stored in the Space at the time the EventBrowser was created and continues to iterate as changes occur in the Space.
NEW The EventBrowser skips iterating through events for those entries stored in the Space at the time the EventBrowser was created and only iterates through events which occur for new entries in the Space.
NEW_EVENTS The EventBrowser skips iterating through events for those entries stored in the Space at the time the EventBrowser was created and only iterates through events which occur for new changes in the Space.
SNAPSHOT The EventBrowser only iterates through events for those entries stored in the Space at the time the EventBrowser was created.

Method Summary

Methods

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

ALL

public static final EventBrowserDef.TimeScope ALL

The EventBrowser iterates through events for all of the entries stored in the Space at the time the EventBrowser was created and continues to iterate as changes occur in the Space.

SNAPSHOT

public static final EventBrowserDef.TimeScope SNAPSHOT

The EventBrowser only iterates through events for those entries stored in the Space at the time the EventBrowser was created.

NEW

public static final EventBrowserDef.TimeScope NEW

The EventBrowser skips iterating through events for those entries stored in the Space at the time the EventBrowser was created and only iterates through events which occur for new entries in the Space.

NEW_EVENTS

public static final EventBrowserDef.TimeScope NEW_EVENTS

The EventBrowser skips iterating through events for those entries stored in the Space at the time the EventBrowser was created and only iterates through events which occur for new changes in the Space. Unlike NEW, NEW_EVENTS includes new events which occur for entries already contained in the Space at the time the EventBrowser was created.

Method Detail

values

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

Returns:

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

valueOf

public static EventBrowserDef.TimeScope 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

getValue

public int getValue()