org.apache.derby.impl.services.timer

Class SingletonTimerFactory

java.lang.Object

org.apache.derby.impl.services.timer.SingletonTimerFactory

All Implemented Interfaces:

ModuleControl, TimerFactory

Direct Known Subclasses:

Java5SingletonTimerFactory

public class SingletonTimerFactory
extends java.lang.Object
implements TimerFactory, ModuleControl

This class implements the TimerFactory interface. It creates a singleton Timer instance. The class implements the ModuleControl interface, because it needs to cancel the Timer at system shutdown.

See Also:

TimerFactory, ModuleControl

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Timer	singletonTimer Singleton Timer instance.

Constructor Summary

Constructors

Constructor and Description
SingletonTimerFactory() Initializes this TimerFactory with a singleton Timer instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	boot(boolean create, java.util.Properties properties) Currently does nothing, singleton Timer instance is initialized in the constructor.
void	cancel(java.util.TimerTask task) Cancel a task.
(package private) java.util.Timer	getCancellationTimer() Returns a Timer object that can be used for adding TimerTasks that cancel executing statements.
void	schedule(java.util.TimerTask task, long delay) Schedule a task.
void	stop() Cancels the singleton Timer instance.

Methods inherited from class java.lang.Object

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

Field Detail

singletonTimer

private java.util.Timer singletonTimer

Singleton Timer instance.

Constructor Detail

SingletonTimerFactory

public SingletonTimerFactory()

Initializes this TimerFactory with a singleton Timer instance.

Method Detail

getCancellationTimer

java.util.Timer getCancellationTimer()

Returns a Timer object that can be used for adding TimerTasks that cancel executing statements.

Returns:

a Timer object for cancelling statements.

schedule

public void schedule(java.util.TimerTask task,
            long delay)

Schedule a task.

Specified by:

schedule in interface TimerFactory

Parameters:

task - the task to schedule

delay - how many milliseconds to wait before executing the task

cancel

public void cancel(java.util.TimerTask task)

Cancel a task.

Specified by:

cancel in interface TimerFactory

Parameters:

task - the task to cancel

boot

public void boot(boolean create,
        java.util.Properties properties)
          throws StandardException

Currently does nothing, singleton Timer instance is initialized in the constructor. Implements the ModuleControl interface.

Specified by:

boot in interface ModuleControl

Throws:

StandardException - Module cannot be started.

See Also:

ModuleControl

stop

public void stop()

Cancels the singleton Timer instance. Implements the ModuleControl interface.

Specified by:

stop in interface ModuleControl

See Also:

ModuleControl