com.neeve.aep
Class AepEngineStopEvent

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.event.Event
          com.neeve.aep.AepEngineStopEvent

All Implemented Interfaces:

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

public final class AepEngineStopEvent
extends Event

Event used to stop an AEP engine.

Threading:

This class is safe for concurrent access by multiple threads.

This event is for private use by the AEP engine. An AEP user does not have any direct use of this event.

Field Summary

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

static AepEngineStopEvent	create(Exception cause) Create a new (initialized) engine stop event.
static Event	create(Properties props) Create a new (uninitialized) engine stop event.
Exception	getCause() Get the reason for the stop.
String	toString() Get a string representation of a engine stop event.

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) engine stop event.

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

create

public static AepEngineStopEvent create(Exception cause)

Create a new (initialized) engine stop event.

Parameters:

cause - Specifies the reason why the engine is stopped. A null value indicates a graceful stop.

This method instantiates and initializes a engine stop event. The method uses the event factory to instantiate a new engine stop event (the factory recycles objects through the event type's object pool is configured for the type) and then initializes it with the supplied parameters.

getCause

public final Exception getCause()

Get the reason for the stop.

Threading:

This method is safe for concurrent access by multiple threads.

toString

public final String toString()

Get a string representation of a engine stop event.

Overrides:

toString in class Event