public abstract class EventBrowserDef
extends java.lang.Object
EventBrowser
.Modifier and Type | Class and Description |
---|---|
static class |
EventBrowserDef.DistributionScope
Enumeration of the possible ways to browse for events in a Space based upon where
entries are stored in the space.
|
static class |
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.
|
Modifier and Type | Field and Description |
---|---|
static int |
NO_WAIT
Calls to the EventBrowser's next() method will return immediately if no events are left
to iterate over.
|
static int |
WAIT_FOREVER
Calls to the EventBrowser's next() method will block endlessly waiting for more events
to iterate over.
|
Constructor and Description |
---|
EventBrowserDef() |
Modifier and Type | Method and Description |
---|---|
static EventBrowserDef |
create()
Instantiate a new EventBrowserDef instance.
|
static EventBrowserDef |
create(long timeout)
Instantiate a new EventBrowserDef instance with the specified timeout.
|
static EventBrowserDef |
create(long timeout,
EventBrowserDef.TimeScope timeScope)
Instantiate a new EventBrowserDef instance with the specified timeout and time scope settings.
|
static EventBrowserDef |
create(long timeout,
EventBrowserDef.TimeScope timeScope,
EventBrowserDef.DistributionScope distributionScope)
Instantiate a new EventBrowserDef instance with the specified timeout, time scope, and distribution
scope settings.
|
abstract EventBrowserDef.DistributionScope |
getDistributionScope()
Retrieve the distribution scope setting of the EventBrowser.
|
abstract long |
getQueryLimit()
Retrieve the query limit setting of the event browser.
|
abstract long |
getTimeout()
Retrieve the timeout setting of the EventBrowser.
|
abstract EventBrowserDef.TimeScope |
getTimeScope()
Retrieve the time scope setting of the EventBrowser.
|
abstract EventBrowserDef |
setDistributionScope(EventBrowserDef.DistributionScope distributionScope)
Sets the distribution scope associated with the EventBrowser.
|
abstract EventBrowserDef |
setQueryLimit(long limit) |
abstract EventBrowserDef |
setTimeout(long timeout)
Sets the timeout value associated with the EventBrowser.
|
abstract EventBrowserDef |
setTimeScope(EventBrowserDef.TimeScope timeScope)
Sets the time scope associated with the EventBrowser.
|
public static int NO_WAIT
public static int WAIT_FOREVER
public static EventBrowserDef create()
public static EventBrowserDef create(long timeout)
timeout
- Number of milliseconds the next() method should block waiting for more events.public static EventBrowserDef create(long timeout, EventBrowserDef.TimeScope timeScope)
timeout
- Number of milliseconds the next() method should block waiting for more events.timeScope
- An enumeration which specifies how to browse for events in the 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.public static EventBrowserDef create(long timeout, EventBrowserDef.TimeScope timeScope, EventBrowserDef.DistributionScope distributionScope)
timeout
- Number of milliseconds the next() method should block waiting for more events.timeScope
- An enumeration which specifies how to browse for events in the 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.distributionScope
- An enumeration which specifies how to browse for events
in the Space based upon where the entries, for which the events occur, are stored
in the space.public abstract EventBrowserDef.TimeScope getTimeScope()
EventBrowserDef.TimeScope
enumeration setting of the EventBrowser.public abstract EventBrowserDef.DistributionScope getDistributionScope()
EventBrowserDef.DistributionScope
enumeration setting of the EventBrowser.public abstract long getTimeout()
public abstract EventBrowserDef setTimeout(long timeout)
NO_WAIT
.timeout
- Number of milliseconds the next() method should block waiting for more events.public abstract EventBrowserDef setDistributionScope(EventBrowserDef.DistributionScope distributionScope)
distributionScope
- An enumeration which specifies how to browse for events
in the Space based upon where the entries, for which the events occur, are stored
in the space.public abstract EventBrowserDef setTimeScope(EventBrowserDef.TimeScope timeScope)
timeScope
- An enumeration which specifies how to browse for events in the 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.public abstract EventBrowserDef setQueryLimit(long limit)
limit
- The number of initial events to get from the Space.public abstract long getQueryLimit()
Copyright (c) 2014 Cloud Software Group, Inc. All rights reserved.