Package editor.util

Interface IProgressCallback

All Known Implementing Classes:
ProgressFeedback

public interface IProgressCallback
An callback interface for indicating progress during a lengthy operation.

Copyright 2010 Guidewire Software, Inc.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
     
    boolean
    incrementProgress(String strMessage, String... args)
     
    boolean
    Should the operation abort?
    void
    Signals that the operation is complete
    void
    setLength(int iLength)
    How long is this operation in units? For a StagedProgressFeedback, this moves to the next stage
    boolean
    updateProgress(int iProgress, String strMessage, String... args)
    Call this when a unit of progress completes.
    boolean
    updateProgress(String strMessage, String... args)
    Call this to update the progress message without modifying the amount of progress completed.
  • Method Details

    • setLength

      void setLength(int iLength)
      How long is this operation in units? For a StagedProgressFeedback, this moves to the next stage
      Parameters:
      iLength - The number of units the operation is expected to execute.
    • updateProgress

      boolean updateProgress(int iProgress, String strMessage, String... args)
      Call this when a unit of progress completes.
      Parameters:
      iProgress - The unit of progress completed.
      strMessage - A short message describing the progress.
      Returns:
      Whether or not the operation should abort. True to abort operation.
    • incrementProgress

      boolean incrementProgress(String strMessage, String... args)
    • updateProgress

      boolean updateProgress(String strMessage, String... args)
      Call this to update the progress message without modifying the amount of progress completed.
    • isAbort

      boolean isAbort()
      Should the operation abort?
      Returns:
      True if the operation should abort.
    • operationComplete

      void operationComplete()
      Signals that the operation is complete
    • getProgress

      int getProgress()