Package org.gvsig.utils.swing.threads

Interface Monitorable

All Known Subinterfaces:
CancellableMonitorable
All Known Implementing Classes:
AbstractMonitorableTask, DefaultCancellableMonitorable
public interface Monitorable
Interface to monitorize a long process, which operates in many individual steps
Author:
azabala

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getCurrentStep()
    Return the number of steps processed
    int
    getFinalStep()
     
    int
    getInitialStep()
     
    boolean
    isDeterminatedProcess()
    Tells if the process is monitoring is defined
    void
    reportStep()
    Report to monitor that an individual step was processed.
    void
    reset()
    Sets initial default monitorization values
    void
    setCurrentStep(int currentStep)
    Allows to modify current step.
    void
    setDeterminatedProcess(boolean defined)
    Reports to the monitor that the process is monitoring is (or not) a defined process.
    void
    setFinalStep(int step)
    report monitor what number has the final step of the process is monitoring (no apply to undefined process)
    void
    setInitialStep(int step)
    report monitor what number has the initial step of the process is monitoring

  • Method Details

    • reportStep

      void reportStep()
      Report to monitor that an individual step was processed.

    • getCurrentStep

      int getCurrentStep()
      Return the number of steps processed
      Returns:

    • setCurrentStep

      void setCurrentStep(int currentStep)
      Allows to modify current step.

    • setInitialStep

      void setInitialStep(int step)
      report monitor what number has the initial step of the process is monitoring
      Parameters:
      step -

    • getInitialStep

      int getInitialStep()

    • getFinalStep

      int getFinalStep()

    • setFinalStep

      void setFinalStep(int step)
      report monitor what number has the final step of the process is monitoring (no apply to undefined process)
      Parameters:
      step -

    • setDeterminatedProcess

      void setDeterminatedProcess(boolean defined)
      Reports to the monitor that the process is monitoring is (or not) a defined process. A defined process is a process whose number of step is predefined (in front of not defined process, which may run in an unknown number of steps)
      Parameters:
      defined -

    • isDeterminatedProcess

      boolean isDeterminatedProcess()
      Tells if the process is monitoring is defined
      Returns:

    • reset

      void reset()
      Sets initial default monitorization values