com.github.sviperll.tasks

Class ConfigurableTask

java.lang.Object

com.github.sviperll.tasks.ConfigurableTask

All Implemented Interfaces:

Task, Closeable, AutoCloseable

public class ConfigurableTask
extends Object
implements Task

Wrapper that adds convinience methods to any task

Constructor Summary

Constructors

Constructor and Description
ConfigurableTask(Task task)

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurableTask	andThen(Task thatTask) Returns new task.
void	close() Performs cleanup for given task, i.e. closes files and any other resources, removes temporary files or database records, etc
ConfigurableTask	closeAfterEachRun() Returns new task.
ConfigurableTask	closingTask() Returns new task.
ConfigurableTask	log(Logger logger, String name) Returns new task.
ConfigurableTask	repeat() Returns new task.
ConfigurableTask	repeat(long pause, TimeUnit unit) Returns new task.
void	run() Performs actual work associated with given task
void	stop() Interrupts current work performed by task and abort any unfinished work
ConfigurableTask	swallowExceptions(Logger logger, long pause, TimeUnit unit) Returns new task.
ConfigurableTask	unstoppable() Returns new task.
ConfigurableTask	withAdditinalClosingAction(Runnable closingAction) Returns new task.
ConfigurableTask	withoutClose() Returns new task.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurableTask

public ConfigurableTask(Task task)

Parameters:

task - task to inherit behaviour from

Method Detail

stop

public void stop()

Description copied from interface: Task

Interrupts current work performed by task and abort any unfinished work

Specified by:

stop in interface Task

run

public void run()

Description copied from interface: Task

Performs actual work associated with given task

Specified by:

run in interface Task

close

public void close()

Description copied from interface: Task

Performs cleanup for given task, i.e. closes files and any other resources, removes temporary files or database records, etc

Specified by:

close in interface Task

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

repeat

public ConfigurableTask repeat(long pause,
                      TimeUnit unit)

Returns new task. When run new task calls #run method of this task repeatly with the pause passed as a parameter

Parameters:

pause - pause between invocations of this task's #run method

unit - TimeUnit to use for pause

Returns:

returns new task

repeat

public ConfigurableTask repeat()

Returns new task. When run new task calls #run method of this task repeatly without pauses

Returns:

returns new task

log

public ConfigurableTask log(Logger logger,
                   String name)

Returns new task. When methods of new task are called their invocations are logged by the logger passed as a parameter

Parameters:

logger - logger that is used to log method invocations

name - name of the task to use in log records

Returns:

returns new task

swallowExceptions

public ConfigurableTask swallowExceptions(Logger logger,
                                 long pause,
                                 TimeUnit unit)

Returns new task. When methods of new task it calls according methods of this task When any exceptions are thrown by the invocation of this task's methods exceptions are not propogated, instead they are logged by given logger and suppressed

Parameters:

logger - logger that is used to log exceptions

Returns:

returns new task

andThen

public ConfigurableTask andThen(Task thatTask)

Returns new task. When #run method is called, at first the #run method of this task is called and then the #run method of thatTask is called

Parameters:

thatTask - task to run after this task

Returns:

returns new task

closeAfterEachRun

public ConfigurableTask closeAfterEachRun()

Returns new task. When #run method is called, at first the #run method of this task is called and then the #close method of this task is called

Close method of resulting task does nothing

Returns:

returns new task

unstoppable

public ConfigurableTask unstoppable()

Returns new task. New task is unstoppable, i. e. #stop method of resulting task does nothing

Returns:

returns new task

withoutClose

public ConfigurableTask withoutClose()

Returns new task. New task performs no cleanup, i. e. #close method of resulting task does nothing

Returns:

returns new task

closingTask

public ConfigurableTask closingTask()

Returns new task. New task performs cleanup of this task as it's main work, i. e. when #run method of resulting task is called #close method of this task is called in response

Returns:

returns new task

withAdditinalClosingAction

public ConfigurableTask withAdditinalClosingAction(Runnable closingAction)

Returns new task. New task performs cleanup action in additinal to this task original cleanup, i. e. when #close method of resulting task is called #close method of this task is called in response and than closingAction passed as a parameter is called

Parameters:

closingAction - additinal closing action

Returns:

returns new task