Autopsy  4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | Private Attributes | List of all members
org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator 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)
 
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 LoggingProgressIndicator loggingIndicator = new LoggingProgressIndicator()
 

Detailed Description

Wrap a LoggingProgressIndicator to support both logging to the log file and the command line.

Definition at line 28 of file CommandLineProgressIndicator.java.

Member Function Documentation

void org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.finish ( )

Finishes the progress indicator when the task is completed.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 72 of file CommandLineProgressIndicator.java.

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

void org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.progress ( String  message)

Updates the progress indicator with a progress message.

Parameters
messageThe progress message.

Implements org.sleuthkit.autopsy.progress.ProgressIndicator.

Definition at line 55 of file CommandLineProgressIndicator.java.

References org.sleuthkit.autopsy.progress.LoggingProgressIndicator.progress().

void org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.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 CommandLineProgressIndicator.java.

References org.sleuthkit.autopsy.progress.LoggingProgressIndicator.progress().

void org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.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 CommandLineProgressIndicator.java.

References org.sleuthkit.autopsy.progress.LoggingProgressIndicator.progress().

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
cancellingMessageThe 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.commandlineingest.CommandLineProgressIndicator.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 CommandLineProgressIndicator.java.

References org.sleuthkit.autopsy.progress.LoggingProgressIndicator.start().

void org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.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 CommandLineProgressIndicator.java.

References org.sleuthkit.autopsy.progress.LoggingProgressIndicator.start().

void org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.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 CommandLineProgressIndicator.java.

References org.sleuthkit.autopsy.progress.LoggingProgressIndicator.switchToDeterminate().

void org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.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 45 of file CommandLineProgressIndicator.java.

References org.sleuthkit.autopsy.progress.LoggingProgressIndicator.switchToIndeterminate().

Member Data Documentation

final LoggingProgressIndicator org.sleuthkit.autopsy.commandlineingest.CommandLineProgressIndicator.loggingIndicator = new LoggingProgressIndicator()
private

Definition at line 30 of file CommandLineProgressIndicator.java.


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

Copyright © 2012-2022 Basis Technology. Generated on: Mon Sep 26 2022
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.