Package com.thebuzzmedia.exiftool.core.schedulers

Class DefaultScheduler

java.lang.Object

com.thebuzzmedia.exiftool.core.schedulers.DefaultScheduler

All Implemented Interfaces:

Scheduler

public class DefaultScheduler
extends Object
implements Scheduler

Default implementation for exiftool Scheduler.
This scheduler will execute a task in a specified amount of time:

• Time must be specified during construction.
• Time unit (milliseconds, seconds, hours, etc.) may be defined during construction.

Note: This scheduler will stop pending task when instance is garbage collected. This is just a small security but we cannot guarantee when instance will be garbage collected. For this reason, it should be up to the caller to stop this scheduler when it is not needed anymore.

Constructor Summary

Constructors

Constructor	Description
DefaultScheduler(long delay)	Deprecated. Use DefaultScheduler(SchedulerDuration) instead.
DefaultScheduler(long delay, TimeUnit timeUnit)	Deprecated. Use DefaultScheduler(SchedulerDuration) instead.
DefaultScheduler(SchedulerDuration executionDelay)	Create new scheduler.
DefaultScheduler(SchedulerDuration executionDelay, SchedulerDuration terminationDelay)	Create new scheduler.

Method Summary

Modifier and Type	Method	Description
void	shutdown()	Shutdown scheduler: once done, the scheduler will not be usable anymore.
void	start(Runnable runnable)	Schedule task.
void	stop()	Stop pending task.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultScheduler

@Deprecated
public DefaultScheduler(long delay)

Deprecated.

Use DefaultScheduler(SchedulerDuration) instead.

Create new scheduler. Default time unit is TimeUnit.MILLISECONDS. A default withExecutor will be created.

Parameters:

delay - Delay.

Throws:

IllegalArgumentException - If delay is less than or equal to zero.

DefaultScheduler

@Deprecated
public DefaultScheduler(long delay,
 TimeUnit timeUnit)

Deprecated.

Use DefaultScheduler(SchedulerDuration) instead.

Create new scheduler. A default withExecutor will be created.

Parameters:

delay - Delay.

timeUnit - Time Unit.

Throws:

NullPointerException - If timeUnit is null.

IllegalArgumentException - If delay is less than or equal to zero.

DefaultScheduler

public DefaultScheduler(SchedulerDuration executionDelay)

Create new scheduler. Default time unit is TimeUnit.MILLISECONDS. A default withExecutor will be created.

Parameters:

executionDelay - The delay between execution.

Throws:

IllegalArgumentException - If delay is less than or equal to zero.

DefaultScheduler

public DefaultScheduler(SchedulerDuration executionDelay,
 SchedulerDuration terminationDelay)

Create new scheduler. A default withExecutor will be created.

Parameters:

executionDelay - The delay between scheduler execution.

terminationDelay - The delay to use to wait for termination when scheduler is shutting down.

Throws:

NullPointerException - If timeUnit is null.

IllegalArgumentException - If delay is less than or equal to zero.

Method Details

start

public void start(Runnable runnable)

Description copied from interface: Scheduler

Schedule task.
Task should not run immediately, instead it should run in a specified amount of time (implementation dependent).

Specified by:

start in interface Scheduler

Parameters:

runnable - Task to run.

stop

public void stop()

Description copied from interface: Scheduler

Stop pending task.

Specified by:

stop in interface Scheduler

shutdown

public void shutdown()

Description copied from interface: Scheduler

Shutdown scheduler: once done, the scheduler will not be usable anymore.

Specified by:

shutdown in interface Scheduler