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

Inherits org.sleuthkit.autopsy.progress.ProgressIndicator.

Public Member Functions

void finish ()
 
void progress (String message)
 
void progress (int workUnitsCompleted)
 
void progress (String message, int workUnitsCompleted)
 
void start (String message, int totalWorkUnits)
 
void start (String message)
 
void switchToDeterminate (String message, int workUnitsCompleted, int totalWorkUnits)
 
void switchToIndeterminate (String message)
 

Private Attributes

final Logger LOGGER = Logger.getLogger(LoggingProgressIndicator.class.getName())
 
int totalWorkUnits
 

Detailed Description

A progress indicator that writes progress to the Autopsy application log.

Definition at line 27 of file LoggingProgressIndicator.java.

Member Function Documentation

void org.sleuthkit.autopsy.progress.LoggingProgressIndicator.finish ( )

Finishes the progress indicator when the task is completed.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 71 of file LoggingProgressIndicator.java.

void org.sleuthkit.autopsy.progress.LoggingProgressIndicator.progress ( String  message)

Updates the progress indicator with a progress message.

Parameters
messageThe progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 56 of file LoggingProgressIndicator.java.

void org.sleuthkit.autopsy.progress.LoggingProgressIndicator.progress ( int  workUnitsCompleted)

Updates the progress indicator with the number of work units completed so far when in determinate mode (the total number of work units to be completed is known).

Parameters
workUnitsCompletedNumber of work units completed so far.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 61 of file LoggingProgressIndicator.java.

void org.sleuthkit.autopsy.progress.LoggingProgressIndicator.progress ( String  message,
int  workUnitsCompleted 
)

Updates the progress indicator with a progress message and the number of work units completed so far when in determinate mode (the total number of work units to be completed is known).

Parameters
messageThe progress message.
workUnitsCompletedNumber of work units completed so far.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 66 of file LoggingProgressIndicator.java.

void org.sleuthkit.autopsy.progress.LoggingProgressIndicator.start ( String  message,
int  totalWorkUnits 
)

Starts the progress indicator in determinate mode (the total number of work units to be completed is known).

Parameters
messageThe initial progress message.
totalWorkUnitsThe total number of work units.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 33 of file LoggingProgressIndicator.java.

References org.sleuthkit.autopsy.progress.LoggingProgressIndicator.totalWorkUnits.

void org.sleuthkit.autopsy.progress.LoggingProgressIndicator.start ( String  message)

Starts the progress indicator in indeterminate mode (the total number of work units to be completed is unknown).

Parameters
messageThe initial progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 39 of file LoggingProgressIndicator.java.

void org.sleuthkit.autopsy.progress.LoggingProgressIndicator.switchToDeterminate ( String  message,
int  workUnitsCompleted,
int  totalWorkUnits 
)

Switches the progress indicator to determinate mode (the total number of work units to be completed is known).

Parameters
messageThe initial progress message.
workUnitsCompletedThe number of work units completed so far.
totalWorkUnitsThe total number of work units to be completed.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 50 of file LoggingProgressIndicator.java.

References org.sleuthkit.autopsy.progress.LoggingProgressIndicator.totalWorkUnits.

void org.sleuthkit.autopsy.progress.LoggingProgressIndicator.switchToIndeterminate ( String  message)

Switches the progress indicator to indeterminate mode (the total number of work units to be completed is unknown).

Parameters
messageThe initial progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 44 of file LoggingProgressIndicator.java.

Member Data Documentation

final Logger org.sleuthkit.autopsy.progress.LoggingProgressIndicator.LOGGER = Logger.getLogger(LoggingProgressIndicator.class.getName())
private

Definition at line 29 of file LoggingProgressIndicator.java.

int org.sleuthkit.autopsy.progress.LoggingProgressIndicator.totalWorkUnits
private

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

Copyright © 2012-2018 Basis Technology. Generated on: Fri Mar 22 2019
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.