EnhancedTimerTask (utils4j)

java.lang.Object
- com.varra.util.EnhancedTimerTask

All Implemented Interfaces:

Computable, Comparable<EnhancedTimerTask>, Runnable

Direct Known Subclasses:

PropertyFileMonitor
```
public abstract class EnhancedTimerTask
extends Object
implements Comparable<EnhancedTimerTask>, Runnable, Computable
```
A task that is executed at a specified time.
Subclasses implement the Periodicity, if needed. Two TimerTasks are compared with their name and next execution time. Note: Use compute() method to write the business logic.

Version:

1.0

Author:

Rajakrishna V. Reddy

Constructor Summary

Constructors
Constructor and Description

EnhancedTimerTask()
Constructor for subclasses.

EnhancedTimerTask(String name)
Constructor for subclasses.

Constructors
Constructor and Description
`EnhancedTimerTask()` Constructor for subclasses.
`EnhancedTimerTask(String name)` Constructor for subclasses.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cancel()` Cancels this `TimerTask`.
`int`	`compareTo(EnhancedTimerTask other)` Compares 2 TimeTasks by comparing their next execution times.
`abstract void`	`compute()` Computes the business logic based on the request of subclasses.
`long`	`getElapsedTime()` Gets the elapsed time.
`Object`	`getEvent()` Gets the event.
`String`	`getName()` Gets the name.
`long`	`getNextExecutionTime()` Returns the next time at which the task will be executed, ie the.
`int`	`getNoOfExecTimes()` Gets the no of exec times.
`int`	`getNoOfPendingTimes()` Gets the no of pending times.
`int`	`getNoOfTimes()` Gets the no of times that executes this particular task.
`long`	`getPeriod()` Returns the period of this task.
`long`	`getPrevExecutionTime()` Gets the prev execution time.
`void`	`incrementNoOfExecTimes()` Increments the no of exec times.
`boolean`	`isCanceled()` Returns whether this task is canceled.
`boolean`	`isDaemon()` Checks if is daemon.
`boolean`	`isExecuteImmediatelySet()` Checks if this is set for immediate execution.
`boolean`	`isExpired()` Checks if is expired.
`boolean`	`isFinished()` Returns whether this task is finished.
`boolean`	`isPeriodic()` Returns whether this task is periodic.
`boolean`	`isRunning()` Checks if this is already in execution.
`boolean`	`isSingleExecutable()` Checks if is single executable.
`void`	`run()` This method implementing is not advised, consider implementing `compute()` method.
`void`	`setDaemon(boolean isDaemon)` Sets the daemon.
`void`	`setEvent(Object event)` Sets the event.
`void`	`setExecuteImmediately(boolean executeImmediately)` Sets this flag if something happens and needs to execute this immediately rather waiting till the interval expires.
`void`	`setExpired(boolean isExpired)` Sets the expired.
`void`	`setNoOfTimes(int noOfTimes)` Sets the no of times to execute this particular task.
`void`	`setPeriod(long period)` Sets the period.
`void`	`setPeriodic(boolean isPeriodic)` Sets the periodic.
`void`	`setPrevExecutionTime(long prevExecutionTime)` Sets the prev execution time.
`void`	`setRunning(boolean running)` Sets this flag to avoid duplicate execution of this in case of the primary execution takes much time than expected.
`void`	`setSingleExecutable(boolean singleExecutable)` Sets the single executable to enable single execution of this instance at any time.
`String`	`toString()`
`void`	`updateNextExecutionTime()` Sets the next execution time.

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

- Constructor Detail
  - EnhancedTimerTask
```
public EnhancedTimerTask()
```
    Constructor for subclasses.
  - EnhancedTimerTask
```
public EnhancedTimerTask(String name)
```
    Constructor for subclasses.
    
    Parameters:
    
    name - the name
- Method Detail
  - compute
```
public abstract void compute()
                      throws ComputingException
```
    Description copied from interface: Computable
    
    Computes the business logic based on the request of subclasses. Pure core business logic will go here with well handled exceptions.
    
    Specified by:
    
    compute in interface Computable
    
    Throws:
    
    ComputingException - the computing exception
  - run
```
public void run()
```
    This method implementing is not advised, consider implementing compute() method.
    
    Specified by:
    
    run in interface Runnable
  - setPeriodic
```
public void setPeriodic(boolean isPeriodic)
```
    Sets the periodic.
    
    Parameters:
    
    isPeriodic - the isPeriodic to set
  - isPeriodic
```
public boolean isPeriodic()
```
    Returns whether this task is periodic. By default return false.
    
    Returns:
    
    true, if is periodic
    
    See Also:
    
    getPeriod()
  - setPeriod
```
public void setPeriod(long period)
```
    Sets the period.
    
    Parameters:
    
    period - the period to set
  - getPeriod
```
public long getPeriod()
```
    Returns the period of this task. By default returns 0.
    
    Returns:
    
    the period
    
    See Also:
    
    isPeriodic
  - getNextExecutionTime
```
public long getNextExecutionTime()
```
    Returns the next time at which the task will be executed, ie the.
    
    Returns:
    
    the next execution time run() method is called.
    
    See Also:
    
    updateNextExecutionTime()
  - updateNextExecutionTime
```
public void updateNextExecutionTime()
```
    Sets the next execution time.
    
    See Also:
    
    getNextExecutionTime()
  - isFinished
```
public boolean isFinished()
```
    Returns whether this task is finished.
    
    Returns:
    
    true, if is finished
    
    See Also:
    
    setFinished(boolean)
  - isExpired
```
public boolean isExpired()
```
    Checks if is expired.
    
    Returns:
    
    the isExpired
  - setExpired
```
public void setExpired(boolean isExpired)
```
    Sets the expired.
    
    Parameters:
    
    isExpired - the isExpired to set
  - isCanceled
```
public boolean isCanceled()
```
    Returns whether this task is canceled.
    
    Returns:
    
    true, if is canceled
    
    See Also:
    
    cancel()
  - cancel
```
public void cancel()
```
    Cancels this TimerTask.
  - compareTo
```
public int compareTo(EnhancedTimerTask other)
```
    Compares 2 TimeTasks by comparing their next execution times.
    
    Specified by:
    
    compareTo in interface Comparable<EnhancedTimerTask>
    
    Parameters:
    
    other - the other
    
    Returns:
    
    the int
    
    See Also:
    
    getNextExecutionTime()
  - setEvent
```
public void setEvent(Object event)
```
    Sets the event.
    
    Parameters:
    
    event - the event to set
  - getEvent
```
public Object getEvent()
```
    Gets the event.
    
    Returns:
    
    the event
  - setPrevExecutionTime
```
public void setPrevExecutionTime(long prevExecutionTime)
```
    Sets the prev execution time.
    
    Parameters:
    
    prevExecutionTime - the prevExecutionTime to set
  - getPrevExecutionTime
```
public long getPrevExecutionTime()
```
    Gets the prev execution time.
    
    Returns:
    
    the prevExecutionTime
  - setNoOfTimes
```
public void setNoOfTimes(int noOfTimes)
```
    Sets the no of times to execute this particular task.
    
    Parameters:
    
    noOfTimes - the noOfTimes to set
  - getNoOfTimes
```
public int getNoOfTimes()
```
    Gets the no of times that executes this particular task.
    
    Returns:
    
    the noOfTimes
  - getNoOfPendingTimes
```
public int getNoOfPendingTimes()
```
    Gets the no of pending times.
    
    Returns:
    
    the noOfPendingTimes
  - incrementNoOfExecTimes
```
public void incrementNoOfExecTimes()
```
    Increments the no of exec times.
  - getNoOfExecTimes
```
public int getNoOfExecTimes()
```
    Gets the no of exec times.
    
    Returns:
    
    the noOfExecTimes
  - getElapsedTime
```
public long getElapsedTime()
```
    Gets the elapsed time.
    
    Returns:
    
    the elapsedTime
  - isDaemon
```
public boolean isDaemon()
```
    Checks if is daemon.
    
    Returns:
    
    the isDaemon
  - setDaemon
```
public void setDaemon(boolean isDaemon)
```
    Sets the daemon.
    
    Parameters:
    
    isDaemon - the isDaemon to set
  - getName
```
public String getName()
```
    Gets the name.
    
    Returns:
    
    the name
  - setExecuteImmediately
```
public void setExecuteImmediately(boolean executeImmediately)
```
    Sets this flag if something happens and needs to execute this immediately rather waiting till the interval expires.
    Mostly useful in RealTime event processing, signal this flag when a event received.
    Note: This doesn't guarantee the immediate execution, rather its just like requesting, GlobalThread will run this as soon as it has free worker threads.
    
    Parameters:
    
    executeImmediately - the executeImmediately to set
    
    Since:
    
    3.0
    
    See Also:
    
    isExecuteImmediatelySet()
  - isExecuteImmediatelySet
```
public boolean isExecuteImmediatelySet()
```
    Checks if this is set for immediate execution.
    
    Returns:
    
    the executeImmediately
    
    Since:
    
    3.0
  - setRunning
```
public void setRunning(boolean running)
```
    Sets this flag to avoid duplicate execution of this in case of the primary execution takes much time than expected.
    
    Parameters:
    
    running - the running to set
    
    Since:
    
    3.0
    
    See Also:
    
    isRunning()
  - isRunning
```
public boolean isRunning()
```
    Checks if this is already in execution.
    
    Returns:
    
    the running
    
    Since:
    
    3.0
  - setSingleExecutable
```
public void setSingleExecutable(boolean singleExecutable)
```
    Sets the single executable to enable single execution of this instance at any time. Note: If one instance is being executed by any thread, any other thread can't execute this.
    
    Parameters:
    
    singleExecutable - the singleExecutable to set
  - isSingleExecutable
```
public boolean isSingleExecutable()
```
    Checks if is single executable.
    
    Returns:
    
    the singleExecutable
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class EnhancedTimerTask

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnhancedTimerTask

EnhancedTimerTask

Method Detail

compute

run

setPeriodic

isPeriodic

setPeriod

getPeriod

getNextExecutionTime

updateNextExecutionTime

isFinished

isExpired

setExpired

isCanceled

cancel

compareTo

setEvent

getEvent

setPrevExecutionTime

getPrevExecutionTime

setNoOfTimes

getNoOfTimes

getNoOfPendingTimes

incrementNoOfExecTimes

getNoOfExecTimes

getElapsedTime

isDaemon

setDaemon

getName

setExecuteImmediately

isExecuteImmediatelySet

setRunning

isRunning

setSingleExecutable

isSingleExecutable

toString