Autopsy  4.18.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt Class Reference

Public Member Functions

 TaskAttempt ()
 
 TaskAttempt (Long delay, TimeUnit timeUnit)
 
 TaskAttempt (Long delay, Long timeOut, TimeUnit timeUnit)
 
Long getDelay ()
 
Long getTimeout ()
 
TimeUnit getTimeUnit ()
 

Private Attributes

final Long delay
 
final Long timeOut
 
final TimeUnit timeUnit
 

Detailed Description

Encapsulates the specification of a task attempt for the attemptTask() utility.

Definition at line 49 of file TaskRetryUtil.java.

Constructor & Destructor Documentation

org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.TaskAttempt ( )

Constructs an object that encapsulates the specification of a task attempt for the attemptTask() utility. The attempt will have neither a delay nor a time out.

Definition at line 60 of file TaskRetryUtil.java.

org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.TaskAttempt ( Long  delay,
TimeUnit  timeUnit 
)

Constructs an object that encapsulates the specification of a task attempt for the attemptTask() utility.

Parameters
delayThe delay before the task should be attempted, may be zero or any positive integer.
timeUnitThe time unit for the delay before the task should be attempted.

Definition at line 75 of file TaskRetryUtil.java.

References org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.delay, and org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.timeUnit.

org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.TaskAttempt ( Long  delay,
Long  timeOut,
TimeUnit  timeUnit 
)

Constructs an object that encapsulates the specification of a task attempt for the attemptTask() utility.

Parameters
delayThe delay before the task should be attempted, must be zero or any positive integer.
timeOutThe timeout for the task attempt, must be zero or any positive integer.
timeUnitThe time unit for the delay before the task should be attempted and the time out.

Definition at line 98 of file TaskRetryUtil.java.

References org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.delay, org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.timeOut, and org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.timeUnit.

Member Function Documentation

Long org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.getDelay ( )

Gets the optional delay before the task should be attempted, may be zero. Call getTimeUnit() to get the time unit for the delay.

Returns
The delay.

Definition at line 119 of file TaskRetryUtil.java.

References org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.delay.

Referenced by org.sleuthkit.autopsy.threadutils.TaskRetryUtil.attemptTask().

Long org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.getTimeout ( )

Gets the the optional timeout for the task attempt, may be zero. Call getTimeUnit() to get the time unit for the delay.

Returns
The timeout.

Definition at line 129 of file TaskRetryUtil.java.

References org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.timeOut.

Referenced by org.sleuthkit.autopsy.threadutils.TaskRetryUtil.attemptTask().

TimeUnit org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.getTimeUnit ( )

Gets the time unit for the optional delay before the task should be attempted and/or the optional time out.

Returns
The time unit.

Definition at line 139 of file TaskRetryUtil.java.

References org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.timeUnit.

Referenced by org.sleuthkit.autopsy.threadutils.TaskRetryUtil.attemptTask().

Member Data Documentation

final Long org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.delay
private
final Long org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.timeOut
private
final TimeUnit org.sleuthkit.autopsy.threadutils.TaskRetryUtil.TaskAttempt.timeUnit
private

The documentation for this class was generated from the following file:

Copyright © 2012-2021 Basis Technology. Generated on: Thu Jul 8 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.