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)

default void	setCancelling (String cancellingMessage)

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.

Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.finish().

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

Updates the progress indicator with a progress message.

Parameters

message The progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 56 of file LoggingProgressIndicator.java.

Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.progress().

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

workUnitsCompleted Number 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

message	The progress message.
workUnitsCompleted	Number of work units completed so far.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 66 of file LoggingProgressIndicator.java.

default void org.sleuthkit.autopsy.progress.ProgressIndicator.setCancelling ( String cancellingMessage )

inherited

If the progress indicator supports cancelling the underlying task, sets a cancelling message and causes the progress indicator to no longer accept updates unless start is called again.

The default implementation assumes that cancelling the underlying task is not supported.

Parameters

cancellingMessage The cancelling messages.

Implemented in org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, and org.sleuthkit.autopsy.progress.AppFrameProgressBar.

Definition at line 100 of file ProgressIndicator.java.

Referenced by org.sleuthkit.autopsy.progress.TaskCancellable.cancel(), and org.sleuthkit.autopsy.casemodule.Case.CancelButtonListener.cancel().

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

message	The initial progress message.
totalWorkUnits	The 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.

Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.start().

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

message The 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

message	The initial progress message.
workUnitsCompleted	The number of work units completed so far.
totalWorkUnits	The 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.

Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.switchToDeterminate().

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

message The initial progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 44 of file LoggingProgressIndicator.java.

Referenced by org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.switchToIndeterminate().