net.morimekta.console.terminal.ProgressTask Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of console-util Show documentation

Utilities helping with various *nix console topics. Mostly geared toward expressive and interactive command line applications.

The newest version!

package net.morimekta.console.terminal;

import java.util.function.LongConsumer;

/**
 * Show progress on a single task in how many percent (with spinner and
 * progress-bar). If closed before finished (updated with the total
 * progress value), it is considered 'cancelled'.
 */
public interface ProgressTask extends LongConsumer, AutoCloseable {
    @Override
    void close();

    /**
     * If the progress task is done or aborted.
     *
     * @return True if done.
     */
    boolean isDone();
}