Interface PathTask

All Superinterfaces:
Runnable

public interface PathTask extends Runnable
Helper interface to define plugin tasks that require post-processing on a specific thread (i.e. the EDT, or JavaFX Platform equivalent).
Author:
Pete Bankhead
  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    Get a description of the results from running this task, which may be used e.g.
    default void
    taskComplete(boolean wasCancelled)
    Perform optional post-processing after a task has completed.

    Methods inherited from interface java.lang.Runnable

    run
  • Method Details

    • taskComplete

      default void taskComplete(boolean wasCancelled)
      Perform optional post-processing after a task has completed.

      When processing a collection of tasks with a TaskRunner, this method should be called on the same thread. The choice of thread depends on the runner, but may be the Event Dispatch Thread when using Swing or Application thread for JavaFX.

      Parameters:
      wasCancelled -
    • getLastResultsDescription

      default String getLastResultsDescription()
      Get a description of the results from running this task, which may be used e.g. in a progress monitor or output to the command line. Default implementation returns null.
      Returns: