Interface Progress

  • All Superinterfaces:
    Future<Map<String,​Object>>
    All Known Implementing Classes:
    ProgressTask

    public interface Progress
    extends Future<Map<String,​Object>>
    Used to report on the progress of a running Process.

    The contents of the Map returned by get() are described by ProcessFactory.getResultInfo(Name, Map) description.

    Author:
    Jody
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static float WORKING
      Value of getProgress used to represent an undefined amount of work.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      float getProgress()
      Amount of work completed.
      • Methods inherited from interface Future

        cancel, get, get, isCancelled, isDone
    • Field Detail

      • WORKING

        static final float WORKING
        Value of getProgress used to represent an undefined amount of work.
        See Also:
        Constant Field Values
    • Method Detail

      • getProgress

        float getProgress()
        Amount of work completed.
        Returns:
        Percent completed, or WORKING if amount of work is unknown.