|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.axonframework.test.eventscheduler.StubEventScheduler
public class StubEventScheduler
EventScheduler implementation that uses it's own concept of "Current Time" for the purpose of testing. Instead of publishing events, it allows (test) classes to obtain a reference to scheduled events for a certain time frame.
To obtain scheduled events, the conceptual "current time" of the Scheduler must be advanced. All events that have been scheduled within the advanced time frame are returned. It is up to the calling class to decide what to do with these events.
Constructor Summary | |
---|---|
StubEventScheduler()
Creates an instance of the StubScheduler that uses the current date time as its conceptual "current time". |
|
StubEventScheduler(org.joda.time.ReadableInstant currentDateTime)
Creates an instance of the StubScheduler that uses the given currentDateTime as its conceptual
"current time". |
Method Summary | |
---|---|
List<EventMessage> |
advanceTime(org.joda.time.DateTime newDateTime)
Advance time to the given newDateTime and returns all events scheduled for publication until that
time. |
List<EventMessage> |
advanceTime(org.joda.time.Duration duration)
Advance time by the given duration and returns all events scheduled for publication until that
time. |
EventMessage |
advanceToNextTrigger()
Advances the "current time" of the scheduler to the next scheduled Event, and returns that event. |
void |
cancelSchedule(ScheduleToken scheduleToken)
Cancel the publication of a scheduled event. |
org.joda.time.DateTime |
getCurrentDateTime()
Returns the "Current Date Time" as used by the scheduler. |
long |
getMillis()
|
List<ScheduledItem> |
getScheduledItems()
Returns a view of all the scheduled Events at the time this method is called. |
ScheduleToken |
schedule(org.joda.time.DateTime triggerDateTime,
Object event)
Schedule the given event for publication at the given triggerDateTime . |
ScheduleToken |
schedule(org.joda.time.Duration triggerDuration,
Object event)
Schedule the given event for publication after the given triggerDuration . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StubEventScheduler()
public StubEventScheduler(org.joda.time.ReadableInstant currentDateTime)
currentDateTime
as its conceptual
"current time".
currentDateTime
- The instant to use as current Date and TimeMethod Detail |
---|
public ScheduleToken schedule(org.joda.time.DateTime triggerDateTime, Object event)
EventScheduler
event
for publication at the given triggerDateTime
. The returned
ScheduleToken can be used to cancel the planned publication.
The given event
may be any object, as well as an EventMessage. In the latter case, the instance
provided is the donor for the payload and Meta Data of the actual message being dispatched. In the former case,
the given event
will be wrapped as the payload of an EventMessage.
schedule
in interface EventScheduler
triggerDateTime
- The moment to trigger publication of the eventevent
- The event to publish
public ScheduleToken schedule(org.joda.time.Duration triggerDuration, Object event)
EventScheduler
event
for publication after the given triggerDuration
. The
returned ScheduleToken can be used to cancel the planned publication.
The given event
may be any object, as well as an EventMessage. In the latter case, the instance
provided is the donor for the payload and Meta Data of the actual message being dispatched. In the former case,
the given event
will be wrapped as the payload of an EventMessage.
schedule
in interface EventScheduler
triggerDuration
- The amount of time to wait before publishing the eventevent
- The event to publish
public void cancelSchedule(ScheduleToken scheduleToken)
EventScheduler
cancelSchedule
in interface EventScheduler
scheduleToken
- the token returned when the event was scheduledpublic List<ScheduledItem> getScheduledItems()
public org.joda.time.DateTime getCurrentDateTime()
public EventMessage advanceToNextTrigger()
public List<EventMessage> advanceTime(org.joda.time.DateTime newDateTime)
newDateTime
and returns all events scheduled for publication until that
time.
newDateTime
- The time to advance the "current time" of the scheduler to
public List<EventMessage> advanceTime(org.joda.time.Duration duration)
duration
and returns all events scheduled for publication until that
time.
duration
- The amount of time to advance the "current time" of the scheduler with
public long getMillis()
getMillis
in interface org.joda.time.DateTimeUtils.MillisProvider
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |