org.axonframework.test.deadline

Class ScheduledDeadlineInfo

java.lang.Object

org.axonframework.test.deadline.ScheduledDeadlineInfo

All Implemented Interfaces:

Comparable<ScheduledDeadlineInfo>

public class ScheduledDeadlineInfo
extends Object
implements Comparable<ScheduledDeadlineInfo>

Holds the data regarding deadline schedule.

Since:

3.3

Author:

Milan Savic, Steven van Beelen

Constructor Summary

Constructors

Constructor and Description
ScheduledDeadlineInfo(Instant scheduleTime, String deadlineName, String scheduleId, int counter, Object messageOrPayload, ScopeDescriptor deadlineScope) Instantiates a ScheduledDeadlineInfo.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ScheduledDeadlineInfo other)
DeadlineMessage	deadlineMessage() Retrieve a DeadlineMessage constructed out of the deadlineName and deadlineInfo.
boolean	equals(Object o)
int	getCounter() Retrieve the counter used to differentiate two deadlines scheduled at the same time.
String	getDeadlineName() Retrieve a String denoting the name of the deadline; can be used together with the scheduleId to cancel the deadline.
ScopeDescriptor	getDeadlineScope() Retrieve a description of the Scope in which the deadline is scheduled.
Object	getMessageOrPayload() Retrieve the payload of the scheduled deadline.
String	getScheduleId() Retrieve a String identifier representing the scheduled deadline; can be used together with the deadlineName to cancel the deadline.
Instant	getScheduleTime() Retrieve the time as an Instant at which the deadline is scheduled.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScheduledDeadlineInfo

public ScheduledDeadlineInfo(Instant scheduleTime,
                             String deadlineName,
                             String scheduleId,
                             int counter,
                             Object messageOrPayload,
                             ScopeDescriptor deadlineScope)

Instantiates a ScheduledDeadlineInfo.

Parameters:

scheduleTime - The time as an Instant at which the deadline is scheduled

deadlineName - A String denoting the name of the deadline; can be used together with the scheduleId to cancel the deadline

scheduleId - A String identifier representing the scheduled deadline; can be used together with the deadlineName to cancel the deadline

counter - Used to differentiate two deadlines scheduled at the same time

messageOrPayload - The payload of the scheduled deadline. Might be null if none is provided

deadlineScope - A description of the Scope in which the deadline is scheduled

Method Detail

getScheduleTime

public Instant getScheduleTime()

Retrieve the time as an Instant at which the deadline is scheduled.

Returns:

the time as an Instant at which the deadline is scheduled

getDeadlineName

public String getDeadlineName()

Retrieve a String denoting the name of the deadline; can be used together with the scheduleId to cancel the deadline.

Returns:

a String denoting the name of the deadline; can be used together with the scheduleId to cancel the deadline

getScheduleId

public String getScheduleId()

Retrieve a String identifier representing the scheduled deadline; can be used together with the deadlineName to cancel the deadline.

Returns:

a String identifier representing the scheduled deadline; can be used together with the deadlineName to cancel the deadline

getCounter

public int getCounter()

Retrieve the counter used to differentiate two deadlines scheduled at the same time.

Returns:

the counter used to differentiate two deadlines scheduled at the same time

getMessageOrPayload

public Object getMessageOrPayload()

Retrieve the payload of the scheduled deadline. Might be null if none is provided.

Returns:

the payload of the scheduled deadline. Might be null if none is provided

getDeadlineScope

public ScopeDescriptor getDeadlineScope()

Retrieve a description of the Scope in which the deadline is scheduled.

Returns:

a description of the Scope in which the deadline is scheduled

deadlineMessage

public DeadlineMessage deadlineMessage()

Retrieve a DeadlineMessage constructed out of the deadlineName and deadlineInfo.

Returns:

a DeadlineMessage constructed out of the deadlineName and deadlineInfo

compareTo

public int compareTo(ScheduledDeadlineInfo other)

Specified by:

compareTo in interface Comparable<ScheduledDeadlineInfo>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object