org.wso2.carbon.metrics.impl.task

Class ScheduledTask

java.lang.Object

org.wso2.carbon.metrics.impl.task.ScheduledTask

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable

Direct Known Subclasses:

ScheduledJDBCMetricsCleanupTask

public abstract class ScheduledTask
extends Object
implements Closeable, Runnable

The abstract base class for scheduled tasks

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ScheduledTask(ScheduledExecutorService executor) Creates a new ScheduledTask instance.
protected	ScheduledTask(String name) Creates a new ScheduledTask instance.

Method Summary

Modifier and Type	Method and Description
void	close() Stops the task and shuts down its thread of execution.
void	start(long period, TimeUnit unit) Starts the tasks with the given period.
void	stop() Stops the task and shuts down its thread of execution.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Constructor Detail

ScheduledTask

protected ScheduledTask(String name)

Creates a new ScheduledTask instance.

Parameters:

name - the task's name

ScheduledTask

protected ScheduledTask(ScheduledExecutorService executor)

Creates a new ScheduledTask instance.

Parameters:

executor - the executor to use while scheduling tasks.

Method Detail

start

public void start(long period,
                  TimeUnit unit)

Starts the tasks with the given period.

Parameters:

period - the amount of time between each run

unit - the unit for period

stop

public void stop()

Stops the task and shuts down its thread of execution. Uses the shutdown pattern from http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ExecutorService.html

close

public void close()

Stops the task and shuts down its thread of execution.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable