org.iota.jota.utils.thread

Class TaskDetails

java.lang.Object

org.iota.jota.utils.thread.TaskDetails

public class TaskDetails
extends Object

This class represents a container for the metadata of a task that was scheduled through an ExecutorService that implements the ReportingExecutorService interface.

It can for example be used to show detailed log messages or even implement more sophisticated features like the BoundedScheduledExecutorService.

Constructor Summary

Constructors

Constructor and Description
TaskDetails() Creates a container for the metadata of a task that was scheduled through an ExecutorService. It is automatically initiated with the calling Thread name, the scheduledForExecution flag being set to true and the executionCount being set to 0.

Method Summary

Modifier and Type	Method and Description
Long	getDelay() Getter for the internal delay property.
AtomicInteger	getExecutionCount() Getter for the internal executionCount property. Note: There is no setter for this property because it returns a mutable object that is not supposed be overwritten.
Long	getInterval() Getter for the internal interval property.
AtomicBoolean	getScheduledForExecution() Getter for the internal scheduledForExecution property. Note: There is no setter for this property because it returns a mutable object that is not supposed be overwritten.
String	getThreadName() Getter for the internal threadName property.
Long	getTimeout() Getter for the internal timeout property.
TimeUnit	getTimeUnit() Getter for the internal timeUnit property.
TaskDetails	setDelay(Long delay) Setter for the internal delay property.
TaskDetails	setInterval(Long interval) Setter for the internal interval property.
TaskDetails	setTimeout(Long timeout) Setter for the internal timeout property.
TaskDetails	setTimeUnit(TimeUnit timeUnit) Setter for the internal timeUnit property.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskDetails

public TaskDetails()

Creates a container for the metadata of a task that was scheduled through an ExecutorService.

It is automatically initiated with the calling Thread name, the scheduledForExecution flag being set to true and the executionCount being set to 0.

Method Detail

getThreadName

public String getThreadName()

Getter for the internal threadName property.

Returns:

name of the Thread that scheduled the task.

getScheduledForExecution

public AtomicBoolean getScheduledForExecution()

Getter for the internal scheduledForExecution property.

Note: There is no setter for this property because it returns a mutable object that is not supposed be overwritten.

Returns:

a thread-safe flag that indicates if the task is currently scheduled for execution

getExecutionCount

public AtomicInteger getExecutionCount()

Getter for the internal executionCount property.

Note: There is no setter for this property because it returns a mutable object that is not supposed be overwritten.

Returns:

a thread-safe counter for the amount of times this task was executed

setDelay

public TaskDetails setDelay(Long delay)

Setter for the internal delay property.

Parameters:

delay - the initial delay that was provided when scheduling the task

Returns:

the instance of TaskDetails itself to allow the chaining of calls

getDelay

public Long getDelay()

Getter for the internal delay property.

Returns:

the initial delay that was provided when scheduling the task (or null if the task was set to run immediately)

setInterval

public TaskDetails setInterval(Long interval)

Setter for the internal interval property.

Parameters:

interval - the interval in which the task is repeated (or null for non-recurring tasks)

Returns:

the instance of TaskDetails itself to allow the chaining of calls

getInterval

public Long getInterval()

Getter for the internal interval property.

Returns:

the interval in which the task is repeated (or null for non-recurring tasks)

setTimeout

public TaskDetails setTimeout(Long timeout)

Setter for the internal timeout property.

Parameters:

timeout - the timeout that a task can take to terminate before it gets interrupted (or null if none was provided)

Returns:

the instance of TaskDetails itself to allow the chaining of calls

getTimeout

public Long getTimeout()

Getter for the internal timeout property.

Returns:

the timeout that a task can take to terminate before it gets interrupted (or null if none was provided)

setTimeUnit

public TaskDetails setTimeUnit(TimeUnit timeUnit)

Setter for the internal timeUnit property.

Parameters:

timeUnit - the time unit that the other values are denominated in (or null if no time based values are provided)

Returns:

the instance of TaskDetails itself to allow the chaining of calls

getTimeUnit

public TimeUnit getTimeUnit()

Getter for the internal timeUnit property.

Returns:

the time unit that the other values are denominated in (or null if no time based values are provided)