Module is.codion.common.model
Package is.codion.common.model.worker

Interface ProgressWorker.ProgressTask<V>

Type Parameters:
V - the intermediate result type
All Known Subinterfaces:
ProgressWorker.ProgressTaskHandler<V>
All Known Implementing Classes:
DomainGeneratorModel.PopulateTask
Enclosing class:
ProgressWorker<T,V>
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public static interface ProgressWorker.ProgressTask<V>
A progress aware background task.

  • Method Details

    • execute

      void execute(ProgressWorker.ProgressReporter<V> progress) throws Exception
      Executes the task.
      Parameters:
      progress - the progress reporter for reporting progress (0 - maximum()) or publishing an intermediate result or message.
      Throws:
      Exception - in case of an exception

    • maximum

      default int maximum()
      Default ProgressWorker.DEFAULT_MAXIMUM (100)
      Returns:
      the maximum progress this task will report