Interface ProgressPlugin

All Known Implementing Classes:
ConsoleProgress, LoggingProgressPlugin, ProgressToOutput

@ProviderType public interface ProgressPlugin
A plugin for reporting progress on long-running jobs.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Represents an ongoing task.
  • Method Summary

    Modifier and Type
    Method
    Description
    startTask(String name, int size)
    Start a task with the specified name.
  • Method Details

    • startTask

      ProgressPlugin.Task startTask(String name, int size)
      Start a task with the specified name.
      Parameters:
      name - The name of the task -- must not be null.
      size - The expected size of the task, or -1 if not known in advance.
      Returns:
      A handle for the ongoing task.