Tasks (sviperll-task 1.0 API)

java.lang.Object
- com.github.sviperll.tasks.Tasks

```
public class Tasks
extends Object
```
Facade-class for Task-object

Constructor Summary

Constructors
Constructor and Description

Tasks()

Constructors
Constructor and Description
`Tasks()`

Method Summary

Methods
Modifier and Type	Method and Description
`static ConfigurableTask`	`closeAfterEachRun(Task task)` Returns task that behaves the same as a Task passed but performes cleanup as the last action performed by run method.
`static ConfigurableTask`	`closingTaskFor(Task task)` Returns task that performs cleanup for the original task when run.
`static ConfigurableTask`	`configure(Task task)` Wrapps task.
`static ConfigurableTask`	`doNothing()`
`static ConfigurableTask`	`factory(TaskFactory factory)` Creates task for given factory When Task#run method of created task is called TaskFactory#createWorkTask method of factory is called and resulting task is runned.
`static ConfigurableTask`	`log(Task task, Logger logger, String name)` Create task that logs invocation of it's methods
`static ConfigurableTask`	`parallel(List<? extends Task> tasks)`
`static ConfigurableTask`	`parallel(Task... tasks)`
`static ConfigurableTask`	`repeat(Task task)` Repeat given task
`static ConfigurableTask`	`repeat(Task task, long pause, TimeUnit unit)` Repeat given task with pauses between task invocation
`static ConfigurableTask`	`runnable(Runnable runnable)` Creates task from Runnable object When Task#run method of created task is called Runnable#run method is called in response Task#close and Task#stop methods of created task does nothong
`static ConfigurableTask`	`sequence(List<? extends Task> tasks)`
`static ConfigurableTask`	`sequence(Task... tasks)`
`static Thread`	`spawn(Task task)` Runs given task in a new thread
`static ConfigurableTask`	`swallowExceptions(Task task, Logger logger, long pause, TimeUnit unit)` Creates new task that catches all exceptions of it's subtask.
`static ConfigurableTask`	`unstoppable(Task task)` Returns task that can't be stopped externally.
`static ConfigurableTask`	`withAdditinalClosingAction(Task task, Runnable closingAction)` Returns task that behaves like the original task but performs additinal cleanup action Resulting task's Task#close method calls original task's Task#close method and given closingAction
`static ConfigurableTask`	`withoutClose(Task task)` Returns task that doesn't perfom cleanup.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Tasks
```
public Tasks()
```
- Method Detail
  - spawn
```
public static Thread spawn(Task task)
```
    Runs given task in a new thread
    
    Parameters:
    task - task to run in new thread
    
    Returns:
    running thread
  - runnable
```
public static ConfigurableTask runnable(Runnable runnable)
```
    Creates task from Runnable object
    When Task#run method of created task is called Runnable#run method is called in response
    Task#close and Task#stop methods of created task does nothong
    
    Parameters:
    runnable - runnable to base task on
    
    Returns:
    new task
  - factory
```
public static ConfigurableTask factory(TaskFactory factory)
```
    Creates task for given factory
    When Task#run method of created task is called TaskFactory#createWorkTask method of factory is called and resulting task is runned. Cleanup for resulting task is performed after.
    When Task#close method of created task is called TaskFactory#createClosingTask method of factory is called and resulting task is runned. Cleanup for resulting task is performed after.
    
    Parameters:
    factory - to create "main" and "cleanup" tasks
    
    Returns:
    new task
  - repeat
```
public static ConfigurableTask repeat(Task task,
                      long pause,
                      TimeUnit unit)
```
    Repeat given task with pauses between task invocation
    
    Parameters:
    task - task to repeat
    pause - pause between invocations of argument task
    unit - time unit of pause
    
    Returns:
    new task that when runned repeats task passed as a parameter
  - repeat
```
public static ConfigurableTask repeat(Task task)
```
    Repeat given task
    
    Parameters:
    task - task to repeat
    
    Returns:
    new task that when runned repeats task passed as a parameter
  - log
```
public static ConfigurableTask log(Task task,
                   Logger logger,
                   String name)
```
    Create task that logs invocation of it's methods
    
    Parameters:
    task - task to perform actual work
    logger - logger to log method invocation by
    name - name to use in log messages
    
    Returns:
    new task that logs it's methods invocation
  - swallowExceptions
```
public static ConfigurableTask swallowExceptions(Task task,
                                 Logger logger,
                                 long pause,
                                 TimeUnit unit)
```
    Creates new task that catches all exceptions of it's subtask. Catches all exceptions, each exception is logged and not rethrown.
    
    Parameters:
    task - subtask to perform action work
    logger - logger to log messages with
    pause - time to sleep after caught exception
    unit - time unit of pause
    
    Returns:
    new task that catches all exceptions
  - doNothing
```
public static ConfigurableTask doNothing()
```
    Returns:
    new task that does nothing
  - sequence
```
public static ConfigurableTask sequence(Task... tasks)
```
    Parameters:
    tasks - array of subtasks
    
    Returns:
    new task that performs each of it's subtasks in order
  - sequence
```
public static ConfigurableTask sequence(List<? extends Task> tasks)
```
    Parameters:
    tasks - list of subtasks
    
    Returns:
    new task that performs each of it's subtasks in order
  - parallel
```
public static ConfigurableTask parallel(Task... tasks)
```
    Parameters:
    tasks - array of subtasks
    
    Returns:
    new task that performs all it's subtasks in parallel
  - parallel
```
public static ConfigurableTask parallel(List<? extends Task> tasks)
```
    Parameters:
    tasks - list of subtasks
    
    Returns:
    new task that performs all it's subtasks in parallel
  - closeAfterEachRun
```
public static ConfigurableTask closeAfterEachRun(Task task)
```
    Returns task that behaves the same as a Task passed but performes cleanup as the last action performed by run method.
    #close method does nothing. When #run method is called, #run method of the original task is called at first and than #close method of the original task is called
    
    Parameters:
    task - to base resulting task on
    
    Returns:
    new task that performs subtask cleanup after subtask's invocation
  - configure
```
public static ConfigurableTask configure(Task task)
```
    Wrapps task. Creates ConfigurableTask based on Task. Behaviour of the resulting task is the same as original task only convinience methods are added.
    
    Parameters:
    task - task to wrap
    
    Returns:
    task with convinience methods
  - unstoppable
```
public static ConfigurableTask unstoppable(Task task)
```
    Returns task that can't be stopped externally. Task#stop method of resulting task does nothing
    
    Parameters:
    task - to base behaviour on
    
    Returns:
    new task that behaves like original task bu can't be stopped
  - withoutClose
```
public static ConfigurableTask withoutClose(Task task)
```
    Returns task that doesn't perfom cleanup. Task#close method of resulting task does nothing
    
    Parameters:
    task - to base behaviour on
    
    Returns:
    new task that behaves like original task but doesn't perform cleanup
  - closingTaskFor
```
public static ConfigurableTask closingTaskFor(Task task)
```
    Returns task that performs cleanup for the original task when run. Resulting task's Task#run method calls original task's Task#close method
    
    Parameters:
    task - to base behaviour on
    
    Returns:
    new task that performs cleanup for the original task
  - withAdditinalClosingAction
```
public static ConfigurableTask withAdditinalClosingAction(Task task,
                                          Runnable closingAction)
```
    Returns task that behaves like the original task but performs additinal cleanup action Resulting task's Task#close method calls original task's Task#close method and given closingAction
    
    Parameters:
    task - to base behaviour on
    closingAction - action to close on cleanup
    
    Returns:
    new task that performs additinal cleanup action

Class Tasks

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Tasks

Method Detail

spawn

runnable

factory

repeat

repeat

log

swallowExceptions

doNothing

sequence

sequence

parallel

parallel

closeAfterEachRun

configure

unstoppable

withoutClose

closingTaskFor

withAdditinalClosingAction