Package org.apache.camel.util.backoff

Class SimpleBackOffTimer

java.lang.Object

org.apache.camel.util.backoff.SimpleBackOffTimer

All Implemented Interfaces:

Closeable, AutoCloseable, BackOffTimer

public class SimpleBackOffTimer
extends Object
implements BackOffTimer, Closeable

A simple timer utility that use a linked BackOff to determine when a task should be executed.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.util.backoff.BackOffTimer

BackOffTimer.Task

Constructor Summary

Constructors

Constructor	Description
SimpleBackOffTimer(String name, ScheduledExecutorService scheduler)
SimpleBackOffTimer(ScheduledExecutorService scheduler)

Method Summary

Modifier and Type	Method	Description
void	close()	Stops and closes this timer.
String	getName()	Gets the name of this timer.
Set<BackOffTimer.Task>	getTasks()	Access to unmodifiable set of all the tasks
void	remove(BackOffTimer.Task task)	Removes the task
BackOffTimer.Task	schedule(BackOff backOff, ThrowingFunction<BackOffTimer.Task,Boolean,Exception> function)	Schedule the given function/task to be executed some time in the future according to the given backOff.
int	size()	Number of tasks

Methods inherited from class java.lang.Object

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

Constructor Details

SimpleBackOffTimer

public SimpleBackOffTimer(ScheduledExecutorService scheduler)

SimpleBackOffTimer

public SimpleBackOffTimer(String name,
 ScheduledExecutorService scheduler)

Method Details

schedule

public BackOffTimer.Task schedule(BackOff backOff,
 ThrowingFunction<BackOffTimer.Task,Boolean,Exception> function)

Schedule the given function/task to be executed some time in the future according to the given backOff.

Specified by:

schedule in interface BackOffTimer

Parameters:

backOff - the settings for how often to run the task

function - the function to call for each run

Returns:

the task

getName

public String getName()

Gets the name of this timer.

Specified by:

getName in interface BackOffTimer

remove

public void remove(BackOffTimer.Task task)

Removes the task

Specified by:

remove in interface BackOffTimer

getTasks

public Set<BackOffTimer.Task> getTasks()

Access to unmodifiable set of all the tasks

Specified by:

getTasks in interface BackOffTimer

size

public int size()

Number of tasks

Specified by:

size in interface BackOffTimer

close

public void close()

Stops and closes this timer.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable