com.neeve.aep

Class AepScheduleEvent

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.event.Event

com.neeve.aep.AepScheduleEvent

All Implemented Interfaces:

IEvent, UtlPool.Item<Event>, UtlReferenceTracker.HasReferenceTracker

public final class AepScheduleEvent
extends Event

Event notifying expiry of a scheduled message or object dispatch.

Threading:

This class is safe for concurrent access by multiple threads.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AepScheduleEvent.HAPolicy Enumerates the set of policies used to recover schedule (events).
static class	AepScheduleEvent.State Enumerates a schedule event's states

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

Methods

Modifier and Type	Method and Description
static Event	create(Properties props) Create a new (uninitialized) schedule event.
long	getCreateTime() Get the schedule (event) create time.
AepScheduleEvent.HAPolicy	getHAPolicy() Get the schedule event's HA policy
long	getId() Get a schedule event's id A schedule event id uniquely identifies a schedule in a cluster
IRogMessage	getMessage() Get the message associated with an event
Object	getObject() Get the object associated with an event
AepScheduleEvent.State	getState() Get a schedule event's state
boolean	isRepeating() Get whether the schedule is repeating schedule.
String	toString() Get a string representation of the object

Methods inherited from class com.neeve.event.Event

acquire, dispose, getAcknowledger, getAttachment, getDelay, getDispatchTime, getInstanceNumber, getOfferTs, getPollTs, getPool, getRemainingTime, getScheduledTime, getSource, getType, init, isEndOfBatch, isHandled, owners, referenceTracker, setAcknowledger, setAttachment, setDelay, setDispatchTime, setEndOfBatch, setHandled, setPool, setScheduledTime, setSource

Methods inherited from class com.neeve.util.UtlListElement

count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static Event create(Properties props)

Create a new (uninitialized) schedule event.

This method instantiates a new schedule event object. The method is for use by the event factory to instantiate new schedule events. The method should not be used directly by the user since the method bypasses any event pooling i.e. it creates a new schedule event object even if there are eligible event objects available in the event type's pool.

getId

public final long getId()

Get a schedule event's id

A schedule event id uniquely identifies a schedule in a cluster

getState

public final AepScheduleEvent.State getState()

Get a schedule event's state

getMessage

public final IRogMessage getMessage()

Get the message associated with an event

Threading:

This method is safe for concurrent access by multiple threads.

getObject

public final Object getObject()

Get the object associated with an event

Threading:

This method is safe for concurrent access by multiple threads.

isRepeating

public final boolean isRepeating()

Get whether the schedule is repeating schedule.

getHAPolicy

public final AepScheduleEvent.HAPolicy getHAPolicy()

Get the schedule event's HA policy

Threading:

This method is safe for concurrent access by multiple threads.

getCreateTime

public final long getCreateTime()

Get the schedule (event) create time.

toString

public String toString()

Get a string representation of the object

Overrides:

toString in class Event