ProgressIndicator.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2017 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.autopsy.progress;

public interface ProgressIndicator {

    void start(String message, int totalWorkUnits);

    void start(String message);

    void switchToIndeterminate(String message);

    void switchToDeterminate(String message, int workUnitsCompleted, int totalWorkUnits);

    void progress(String message);

    void progress(int workUnitsCompleted);

    void progress(String message, int workUnitsCompleted);

    default void setCancelling(String cancellingMessage) {
        /*
         * The default implementation assumes that cancelling the underlying
         * task is not supported.
         */
    }

    void finish();

}