Autopsy  4.13.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
Public Member Functions | List of all members
org.sleuthkit.autopsy.progress.ProgressIndicator Interface Reference

Inherited by org.sleuthkit.autopsy.progress.AppFrameProgressBar, org.sleuthkit.autopsy.progress.LoggingProgressIndicator, org.sleuthkit.autopsy.progress.ModalDialogProgressIndicator, and org.sleuthkit.autopsy.progress.SilentProgressIndicator.

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)
 

Detailed Description

An interface for progress indicators. A progress indicator can run in determinate mode (the total number of work units to be completed is known) or indeterminate mode. Switching back and forth between the two modes is supported. Starting, finishing, and starting again is supported.

Definition at line 27 of file ProgressIndicator.java.

Member Function Documentation

void org.sleuthkit.autopsy.progress.ProgressIndicator.finish ( )
void org.sleuthkit.autopsy.progress.ProgressIndicator.progress ( String  message)

Updates the progress indicator with a progress message.

Parameters
messageThe progress message.

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

Referenced by org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.cancel(), org.sleuthkit.autopsy.casemodule.Case.close(), org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.complete(), org.sleuthkit.autopsy.casemodule.Case.createCaseDatabase(), org.sleuthkit.autopsy.casemodule.Case.createCaseDirectoryIfDoesNotExist(), org.sleuthkit.autopsy.casemodule.Case.createCaseNodeData(), org.sleuthkit.autopsy.casemodule.Case.deleteCaseDirectory(), org.sleuthkit.autopsy.casemodule.Case.deleteFromRecentCases(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCase(), org.sleuthkit.autopsy.casemodule.Case.deleteMultiUserCaseDatabase(), org.sleuthkit.autopsy.casemodule.Case.deleteTempfilesFromCaseDirectory(), org.sleuthkit.autopsy.casemodule.Case.deleteTextIndex(), org.sleuthkit.autopsy.casemodule.Case.doCloseCaseAction(), org.sleuthkit.autopsy.communications.CommunicationsGraph.RebuildWorker.doInBackground(), org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.increment(), org.sleuthkit.autopsy.casemodule.Case.openAppServiceCaseResources(), org.sleuthkit.autopsy.casemodule.Case.openCaseDataBase(), org.sleuthkit.autopsy.casemodule.Case.openCaseLevelServices(), org.sleuthkit.autopsy.test.TestAutopsyService.openCaseResources(), org.sleuthkit.autopsy.keywordsearch.SolrSearchService.openCaseResources(), org.sleuthkit.autopsy.casemodule.Case.openCommunicationChannels(), org.sleuthkit.autopsy.casemodule.Case.saveCaseMetadataToFile(), org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.setProgress(), org.sleuthkit.autopsy.casemodule.Case.switchLoggingToCaseLogsDirectory(), org.sleuthkit.autopsy.casemodule.Case.updateCaseNodeData(), and org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.updateStatusLabel().

void org.sleuthkit.autopsy.progress.ProgressIndicator.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.

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

void org.sleuthkit.autopsy.progress.ProgressIndicator.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.

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

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

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.progress.ProgressIndicator.start ( String  message,
int  totalWorkUnits 
)
void org.sleuthkit.autopsy.progress.ProgressIndicator.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.

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

void org.sleuthkit.autopsy.progress.ProgressIndicator.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.

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

Referenced by org.sleuthkit.autopsy.communications.CommunicationsGraph.RebuildWorker.doInBackground(), and org.sleuthkit.autopsy.report.infrastructure.ReportProgressIndicator.setMaximumProgress().

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

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

Copyright © 2012-2019 Basis Technology. Generated on: Tue Jan 7 2020
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.