SchedulerJob (mhu-lib-core 3.2.9 API)

java.lang.Object
- java.util.TimerTask
- - de.mhus.lib.core.MTimerTask
  - - de.mhus.lib.core.schedule.SchedulerJob

All Implemented Interfaces:

Named, Operation, Runnable, Observer

Direct Known Subclasses:

CronJob, IntervalJob, IntervalWithStartTimeJob, OnceJob, SchedulerJobProxy
```
public abstract class SchedulerJob
extends MTimerTask
implements Operation
```
Abstract SchedulerJob class.

Since:

3.2.9

Version:

$Id: $Id

Author:

mikehummel

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class SchedulerJob.MyTaskContext

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`SchedulerJob.MyTaskContext`

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`CALCULATE_NEXT` Constant `CALCULATE_NEXT=0`
`protected SchedulerJob.MyTaskContext`	`context`
`static long`	`DISABLED_TIME` Constant `DISABLED_TIME=-1`
`protected static Log`	`log` Constant `log`
`static long`	`REMOVE_TIME` Constant `REMOVE_TIME=-2`

Constructor Summary

Constructors
Constructor and Description

SchedulerJob(Observer task)
Constructor for SchedulerJob.

SchedulerJob(String name, Observer task)
Constructor for SchedulerJob.

Constructors
Constructor and Description
`SchedulerJob(Observer task)` Constructor for SchedulerJob.
`SchedulerJob(String name, Observer task)` Constructor for SchedulerJob.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canExecute(TaskContext context)` canExecute.
`protected abstract void`	`doCaclulateNextExecution()` Calculate the next executionTime and store it into nextExecutionTime
`protected void`	`doError(Throwable t)` doError.
`OperationResult`	`doExecute(TaskContext context)` doExecute.
`protected OperationResult`	`doExecute2(TaskContext context)` doExecute2.
`void`	`doit()` doit.
`protected void`	`doReschedule(Scheduler scheduler, long time)` doReschedule.
`protected void`	`doSchedule(Scheduler scheduler)` doSchedule.
`void`	`doTick()` Call this method to fire ticks to the scheduler.
`void`	`doTimeoutReached()` If you have defined a timeout, the event will be called every minute.
`OperationDescription`	`getDescription()` getDescription.
`long`	`getLastExecutionStart()` Getter for the field `lastExecutionStart`.
`long`	`getLastExecutionStop()` Getter for the field `lastExecutionStop`.
`long`	`getNextExecutionTime()` Getter for the field `nextExecutionTime`.
`Object`	`getOwner()` Getter for the field `owner`.
`long`	`getScheduledTime()` Getter for the field `scheduledTime`.
`Observer`	`getTask()` Getter for the field `task`.
`Thread`	`getThread()` Getter for the field `thread`.
`long`	`getTimeoutInMinutes()` Getter for the field `timeoutInMinutes`.
`boolean`	`hasAccess()` hasAccess.
`boolean`	`isBusy()` isBusy.
`boolean`	`isDone()` isDone.
`protected boolean`	`isExecutionTimeReached()` By default the function will compare the nextExecutionTime with the current time.
`boolean`	`releaseBusy(Object owner)` releaseBusy.
`boolean`	`setBusy(Object owner)` setBusy.
`protected void`	`setDone(boolean done)` Setter for the field `done`.
`void`	`setNextExecutionTime(long nextExecutionTime)` Setter for the field `nextExecutionTime`.
`protected void`	`setScheduledTime(long scheduledTime)` Setter for the field `scheduledTime`.
`protected void`	`setTask(Observer task)` Setter for the field `task`.
`void`	`setTimeoutInMinutes(long timeoutInMinutes)` Setter for the field `timeoutInMinutes`.
`String`	`toString()`

Methods inherited from class de.mhus.lib.core.MTimerTask
cancel, getName, isCanceled, onError, onFinal, run, setCanceled, setName, update

Methods inherited from class java.util.TimerTask
scheduledExecutionTime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CALCULATE_NEXT
```
public static final long CALCULATE_NEXT
```
    Constant CALCULATE_NEXT=0
    
    See Also:
    
    Constant Field Values
  - DISABLED_TIME
```
public static final long DISABLED_TIME
```
    Constant DISABLED_TIME=-1
    
    See Also:
    
    Constant Field Values
  - REMOVE_TIME
```
public static final long REMOVE_TIME
```
    Constant REMOVE_TIME=-2
    
    See Also:
    
    Constant Field Values
  - log
```
protected static Log log
```
    Constant log
  - context
```
protected SchedulerJob.MyTaskContext context
```
- Constructor Detail
  - SchedulerJob
```
public SchedulerJob(Observer task)
```
    Constructor for SchedulerJob.
    
    Parameters:
    
    task - a Observer object.
  - SchedulerJob
```
public SchedulerJob(String name,
                    Observer task)
```
    Constructor for SchedulerJob.
    
    Parameters:
    
    name - a String object.
    
    task - a Observer object.
- Method Detail
  - doTick
```
public void doTick()
```
    Call this method to fire ticks to the scheduler. If the time is come the scheduler will execute the operation and set 'done' to true.
  - doCaclulateNextExecution
```
protected abstract void doCaclulateNextExecution()
```
    Calculate the next executionTime and store it into nextExecutionTime
  - doExecute
```
public final OperationResult doExecute(TaskContext context)
                                throws Exception
```
    doExecute.
    
    Specified by:
    
    doExecute in interface Operation
    
    Parameters:
    
    context - a TaskContext object.
    
    Returns:
    
    a OperationResult object.
    
    Throws:
    
    Exception - if any.
  - doExecute2
```
protected OperationResult doExecute2(TaskContext context)
                              throws Exception
```
    doExecute2.
    
    Parameters:
    
    context - a TaskContext object.
    
    Returns:
    
    a OperationResult object.
    
    Throws:
    
    Exception - if any.
  - isBusy
```
public boolean isBusy()
```
    isBusy.
    
    Specified by:
    
    isBusy in interface Operation
    
    Returns:
    
    a boolean.
  - setBusy
```
public boolean setBusy(Object owner)
```
    setBusy.
    
    Specified by:
    
    setBusy in interface Operation
    
    Parameters:
    
    owner - a Object object.
    
    Returns:
    
    a boolean.
  - releaseBusy
```
public boolean releaseBusy(Object owner)
```
    releaseBusy.
    
    Specified by:
    
    releaseBusy in interface Operation
    
    Parameters:
    
    owner - a Object object.
    
    Returns:
    
    a boolean.
  - getOwner
```
public Object getOwner()
```
    Getter for the field owner.
    
    Returns:
    
    a Object object.
  - isExecutionTimeReached
```
protected boolean isExecutionTimeReached()
```
    By default the function will compare the nextExecutionTime with the current time. If the time is come it will return true. If nextExecutionTime is 0 or less it will return false in every case.
    
    Returns:
    
    a boolean.
  - isDone
```
public boolean isDone()
```
    isDone.
    
    Returns:
    
    a boolean.
  - setDone
```
protected void setDone(boolean done)
```
    Setter for the field done.
    
    Parameters:
    
    done - a boolean.
  - hasAccess
```
public boolean hasAccess()
```
    hasAccess.
    
    Specified by:
    
    hasAccess in interface Operation
    
    Returns:
    
    a boolean.
  - canExecute
```
public boolean canExecute(TaskContext context)
```
    canExecute.
    
    Specified by:
    
    canExecute in interface Operation
    
    Parameters:
    
    context - a TaskContext object.
    
    Returns:
    
    a boolean.
  - getDescription
```
public OperationDescription getDescription()
```
    getDescription.
    
    Specified by:
    
    getDescription in interface Operation
    
    Returns:
    
    a OperationDescription object.
  - getTask
```
public Observer getTask()
```
    Getter for the field task.
    
    Returns:
    
    a Observer object.
  - setTask
```
protected void setTask(Observer task)
```
    Setter for the field task.
    
    Parameters:
    
    task - a Observer object.
  - doit
```
public void doit()
          throws Exception
```
    doit.
    
    Specified by:
    
    doit in class MTimerTask
    
    Throws:
    
    Exception - if any.
  - getNextExecutionTime
```
public long getNextExecutionTime()
```
    Getter for the field nextExecutionTime.
    
    Returns:
    
    a long.
  - doError
```
protected void doError(Throwable t)
```
    doError.
    
    Parameters:
    
    t - a Throwable object.
  - doSchedule
```
protected void doSchedule(Scheduler scheduler)
```
    doSchedule.
    
    Parameters:
    
    scheduler - a Scheduler object.
  - doReschedule
```
protected void doReschedule(Scheduler scheduler,
                            long time)
```
    doReschedule.
    
    Parameters:
    
    scheduler - a Scheduler object.
    
    time - a long.
  - getLastExecutionStart
```
public long getLastExecutionStart()
```
    Getter for the field lastExecutionStart.
    
    Returns:
    
    a long.
  - getLastExecutionStop
```
public long getLastExecutionStop()
```
    Getter for the field lastExecutionStop.
    
    Returns:
    
    a long.
  - getScheduledTime
```
public long getScheduledTime()
```
    Getter for the field scheduledTime.
    
    Returns:
    
    a long.
  - setScheduledTime
```
protected void setScheduledTime(long scheduledTime)
```
    Setter for the field scheduledTime.
    
    Parameters:
    
    scheduledTime - a long.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getTimeoutInMinutes
```
public long getTimeoutInMinutes()
```
    Getter for the field timeoutInMinutes.
    
    Returns:
    
    a long.
  - setTimeoutInMinutes
```
public void setTimeoutInMinutes(long timeoutInMinutes)
```
    Setter for the field timeoutInMinutes.
    
    Parameters:
    
    timeoutInMinutes - a long.
  - doTimeoutReached
```
public void doTimeoutReached()
```
    If you have defined a timeout, the event will be called every minute. Be carefully with the execution time of this event, it can hem the hole scheduler.
  - getThread
```
public Thread getThread()
```
    Getter for the field thread.
    
    Returns:
    
    a Thread object.
  - setNextExecutionTime
```
public void setNextExecutionTime(long nextExecutionTime)
```
    Setter for the field nextExecutionTime.
    
    Parameters:
    
    nextExecutionTime - a long.

Class SchedulerJob

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class de.mhus.lib.core.MTimerTask

Methods inherited from class java.util.TimerTask

Methods inherited from class java.lang.Object

Field Detail

CALCULATE_NEXT

DISABLED_TIME

REMOVE_TIME

log

context

Constructor Detail

SchedulerJob

SchedulerJob

Method Detail

doTick

doCaclulateNextExecution

doExecute

doExecute2

isBusy

setBusy

releaseBusy

getOwner

isExecutionTimeReached

isDone

setDone

hasAccess

canExecute

getDescription

getTask

setTask

doit

getNextExecutionTime

doError

doSchedule

doReschedule

getLastExecutionStart

getLastExecutionStop

getScheduledTime

setScheduledTime

toString

getTimeoutInMinutes

setTimeoutInMinutes

doTimeoutReached

getThread

setNextExecutionTime