Package org.jboss.windup.tooling

Interface WindupToolingProgressMonitor

  • All Superinterfaces:
    Remote
    All Known Implementing Classes:
    ProgressMonitorAdapter
    public interface WindupToolingProgressMonitor
extends Remote
    Extends the standard progress monitor to also tie in with the logging system. Messages from Java Util Logging (aka JUL) will be passed through this if the provided listener is an instance of WindupToolingProgressMonitor.
    Author:
    Jesse Sightler

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int UNKNOWN
      Constant indicating an unknown amount of work.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void beginTask​(String name, int totalWork)
      Notifies that the main task is beginning.
      void done()
      Notifies that the work is done; that is, either the main task is completed or the user canceled it.
      boolean isCancelled()
      Returns whether cancellation of current operation has been requested.
      void logMessage​(LogRecord logRecord)
      Called for each LogRecord generated by Windup.
      void setCancelled​(boolean value)
      Sets the cancel state to the given value.
      void setTaskName​(String name)
      Sets the task name to the given value.
      void subTask​(String name)
      Notifies that a subtask of the main task is beginning.
      void worked​(int work)
      Notifies that a given number of work unit of the main task has been completed.

    • Field Detail

      • UNKNOWN

        static final int UNKNOWN
        Constant indicating an unknown amount of work.
        See Also:
        Constant Field Values

    • Method Detail

      • beginTask

        void beginTask​(String name,
               int totalWork)
        throws RemoteException
        Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.
        Parameters:
        name - the name (or description) of the main task
        totalWork - the total number of work units into which the main task is been subdivided. If the value is UNKNOWN the implementation is free to indicate progress in a way which doesn't require the total number of work units in advance.
        Throws:
        RemoteException

      • done

        void done()
   throws RemoteException
        Notifies that the work is done; that is, either the main task is completed or the user canceled it. This method may be called more than once (implementations should be prepared to handle this case).
        Throws:
        RemoteException

      • isCancelled

        boolean isCancelled()
             throws RemoteException
        Returns whether cancellation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.
        Returns:
        true if cancellation has been requested, and false otherwise
        Throws:
        RemoteException
        See Also:
        setCancelled(boolean)

      • setCancelled

        void setCancelled​(boolean value)
           throws RemoteException
        Sets the cancel state to the given value.
        Parameters:
        value - true indicates that cancellation has been requested (but not necessarily acknowledged); false clears this flag
        Throws:
        RemoteException
        See Also:
        isCancelled()

      • setTaskName

        void setTaskName​(String name)
          throws RemoteException
        Sets the task name to the given value. This method is used to restore the task label after a nested operation was executed. Normally there is no need for clients to call this method.
        Parameters:
        name - the name (or description) of the main task
        Throws:
        RemoteException
        See Also:
        beginTask(java.lang.String, int)

      • subTask

        void subTask​(String name)
      throws RemoteException
        Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.
        Parameters:
        name - the name (or description) of the subtask
        Throws:
        RemoteException

      • worked

        void worked​(int work)
     throws RemoteException
        Notifies that a given number of work unit of the main task has been completed. Note that this amount represents an installment, as opposed to a cumulative amount of work done to date.
        Parameters:
        work - a non-negative number of work units just completed
        Throws:
        RemoteException