Package org.gephi.utils.progress

Interface ProgressTicket

  • public interface ProgressTicket
    Progress task following, must be used from Progress class.
    Author:
    Mathieu Bastian

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void finish()
      Finish the progress task.
      void finish​(String finishMessage)
      Finish the progress task and show and wrap-up message
      String getDisplayName()
      Returns the current display name
      void progress()
      Notify the user about a new completed unit.
      void progress​(int workunit)
      Notify the user about completed workunits.
      void progress​(String message)
      Notify the user about progress by showing message with details.
      void progress​(String message, int workunit)
      Notify the user about completed workunits and show additional detailed message.
      void setDisplayName​(String newDisplayName)
      Change the display name of the progress task.
      void start()
      Start the progress indication for indeterminate task.
      void start​(int workunits)
      Start the progress indication for a task with known number of steps.
      void switchToDeterminate​(int workunits)
      Currently indeterminate task can be switched to show percentage completed.
      void switchToIndeterminate()
      Currently determinate task can be switched to indeterminate mode.

    • Method Detail

      • finish

        void finish()
        Finish the progress task.

      • finish

        void finish​(String finishMessage)
        Finish the progress task and show and wrap-up message
        Parameters:
        finishMessage - a message about the finished task

      • progress

        void progress()
        Notify the user about a new completed unit. Equivalent to incrementing workunits by one.

      • progress

        void progress​(int workunit)
        Notify the user about completed workunits.
        Parameters:
        workunit - a cumulative number of workunits completed so far

      • progress

        void progress​(String message)
        Notify the user about progress by showing message with details.
        Parameters:
        message - about the status of the task

      • progress

        void progress​(String message,
              int workunit)
        Notify the user about completed workunits and show additional detailed message.
        Parameters:
        message - details about the status of the task
        workunit - a cumulative number of workunits completed so far

      • getDisplayName

        String getDisplayName()
        Returns the current display name
        Returns:
        the current display name

      • setDisplayName

        void setDisplayName​(String newDisplayName)
        Change the display name of the progress task. Use with care, please make sure the changed name is not completely different, or otherwise it might appear to the user as a different task.
        Parameters:
        newDisplayName - the new display name

      • start

        void start()
        Start the progress indication for indeterminate task.

      • start

        void start​(int workunits)
        Start the progress indication for a task with known number of steps.
        Parameters:
        workunits - total number of workunits that will be processed

      • switchToDeterminate

        void switchToDeterminate​(int workunits)
        Currently indeterminate task can be switched to show percentage completed.
        Parameters:
        workunits - workunits total number of workunits that will be processed

      • switchToIndeterminate

        void switchToIndeterminate()
        Currently determinate task can be switched to indeterminate mode.