SwingWorkerSequentialExecutor.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2020 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.datasourcesummary.uiutils;

import com.google.common.util.concurrent.ThreadFactoryBuilder;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.stream.Collectors;
import javax.swing.SwingWorker;

public class SwingWorkerSequentialExecutor {

    private final ExecutorService executorService = Executors.newFixedThreadPool(1, new ThreadFactoryBuilder().setNameFormat("SwingWorkerSequentialExecutor-%d").build());
    private List<? extends SwingWorker<?, ?>> workers = Collections.emptyList();
    private List<Future<?>> futures = Collections.emptyList();

    public synchronized void submit(List<? extends SwingWorker<?, ?>> submittedWorkers) {
        // cancel currently running operations
        cancelRunning();

        // if no workers, there is nothing to run
        if (submittedWorkers == null) {
            return;
        }

        this.workers = new ArrayList<>(submittedWorkers);

        // start running the workers and capture the futures if there is a need to cancel them.
        this.futures = this.workers.stream()
                .map((w) -> executorService.submit(w))
                .collect(Collectors.toList());
    }

    public synchronized void cancelRunning() {
        futures.forEach((f) -> f.cancel(true));
        workers = Collections.emptyList();
        futures = Collections.emptyList();
    }

    public synchronized boolean isRunning() {
        // borrowed from this stack overflow answer: 
        // https://stackoverflow.com/a/33845730

        for (Future<?> future : futures) {
            if (!future.isDone()) {
                return true;
            }
        }

        return false;
    }
}