Package org.jboss.as.ejb3.timerservice

Class CalendarTimer

java.lang.Object

org.jboss.as.ejb3.timerservice.TimerImpl

org.jboss.as.ejb3.timerservice.CalendarTimer

All Implemented Interfaces:

javax.ejb.Timer

public class CalendarTimer
extends TimerImpl

Represents a Timer which is created out a calendar expression

Version:

$Revision: $

Author:

Jaikiran Pai

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CalendarTimer.Builder

Field Summary

Fields inherited from class org.jboss.as.ejb3.timerservice.TimerImpl

id, info, initialExpiration, intervalDuration, nextExpiration, persistent, previousRun, timedObjectInvoker, timerService, timerState

Constructor Summary

Constructors

Constructor	Description
CalendarTimer(CalendarTimer.Builder builder, TimerServiceImpl timerService)

Method Summary

Modifier and Type	Method	Description
static CalendarTimer.Builder	builder()
CalendarBasedTimeout	getCalendarTimeout()	Returns the CalendarBasedTimeout corresponding to this CalendarTimer
javax.ejb.ScheduleExpression	getSchedule()
javax.ejb.ScheduleExpression	getScheduleExpression()	This method is similar to getSchedule(), except that this method does not check the timer state and hence does not throw either IllegalStateException or NoSuchObjectLocalException or EJBException.
Method	getTimeoutMethod()
static Method	getTimeoutMethod(TimeoutMethod timeoutMethodInfo, ClassLoader classLoader)	Returns the Method, represented by the TimeoutMethod
protected CalendarTimerTask	getTimerTask()	Returns the task which handles the timeouts on this CalendarTimer
void	handleRestorationCalculation()	Makes sure that the timer is only run once after being restored.
boolean	isAutoTimer()	Returns true if this is an auto-timer.
boolean	isCalendarTimer()
String	toString()	A nice formatted string output for this timer

Methods inherited from class org.jboss.as.ejb3.timerservice.TimerImpl

assertTimerState, cancel, equals, getCachedTimerInfo, getExecutingThread, getHandle, getId, getInfo, getInitialExpiration, getInterval, getNextExpiration, getNextTimeout, getPreviousRun, getState, getTimedObjectId, getTimeRemaining, getTimerInfo, getTimerService, hashCode, invokeOneOff, isActive, isCanceled, isExpired, isInRetry, isPersistent, lock, scheduleTimeout, setCachedTimerInfo, setNextTimeout, setPreviousRun, setTimerState, suspend, unlock

Methods inherited from class java.lang.Object

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

Constructor Detail

CalendarTimer

public CalendarTimer(CalendarTimer.Builder builder,
                     TimerServiceImpl timerService)

Method Detail

getSchedule

public javax.ejb.ScheduleExpression getSchedule()
                                         throws IllegalStateException,
                                                javax.ejb.EJBException

Specified by:

getSchedule in interface javax.ejb.Timer

Overrides:

getSchedule in class TimerImpl

Throws:

IllegalStateException

javax.ejb.EJBException

See Also:

getScheduleExpression()

getScheduleExpression

public javax.ejb.ScheduleExpression getScheduleExpression()

This method is similar to getSchedule(), except that this method does not check the timer state and hence does not throw either IllegalStateException or NoSuchObjectLocalException or EJBException.

Returns:

isCalendarTimer

public boolean isCalendarTimer()
                        throws IllegalStateException,
                               javax.ejb.EJBException

Specified by:

isCalendarTimer in interface javax.ejb.Timer

Overrides:

isCalendarTimer in class TimerImpl

Throws:

IllegalStateException

javax.ejb.EJBException

getCalendarTimeout

public CalendarBasedTimeout getCalendarTimeout()

Returns the CalendarBasedTimeout corresponding to this CalendarTimer

Returns:

isAutoTimer

public boolean isAutoTimer()

Returns true if this is an auto-timer. Else returns false.

Overrides:

isAutoTimer in class TimerImpl

getTimerTask

protected CalendarTimerTask getTimerTask()

Returns the task which handles the timeouts on this CalendarTimer

Overrides:

getTimerTask in class TimerImpl

Returns:

See Also:

CalendarTimerTask

getTimeoutMethod

public Method getTimeoutMethod()

builder

public static CalendarTimer.Builder builder()

handleRestorationCalculation

public void handleRestorationCalculation()

Makes sure that the timer is only run once after being restored.

getTimeoutMethod

public static Method getTimeoutMethod(TimeoutMethod timeoutMethodInfo,
                                      ClassLoader classLoader)

Returns the Method, represented by the TimeoutMethod

Note: This method uses the Thread.getContextClassLoader() to load the relevant classes while getting the Method

Parameters:

timeoutMethodInfo - The timeout method

classLoader - The class loader

Returns:

timeout method matching timeoutMethodInfo

toString

public String toString()

A nice formatted string output for this timer . For calendar-based timer, the string output also includes its schedule expression value.

Overrides:

toString in class TimerImpl

Returns:

a string representation of calendar-based timer