com.rational.test.ft.services

Class NullActionMonitor

  • java.lang.Object
    • com.rational.test.ft.services.NullActionMonitor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void action(java.lang.String sMessage)
      Post an action message to the monitor.
      void beginTask(java.lang.String name, int totalWork)
      Notifies that the main task is beginning.
      void checkCancel() 
      void done()
      Notifies that the work is done; that is, either the main task is completed or the user canceled it.
      int getDetailLevel()
      Suppling the detail level to the interface consumer is an optimization that allows the consumer to avoid generating potentially expensive messages that will not be utilized.
      void highLevel(java.lang.String sMessage)
      Post a high level message to the monitor.
      boolean isCanceled()
      Returns whether cancelation of current operation has been requested.
      void setItemCount(int count, int level) 
      void subTask(java.lang.String name)
      Notifies that a subtask of the main task is beginning.
      void verbose(java.lang.String sMessage)
      Post a verbose message to the monitor.
      void worked(int work)
      Notifies that a given number of work unit of the main task has been completed.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • NullActionMonitor

        public NullActionMonitor()

    • Method Detail

      • verbose

        public void verbose(java.lang.String sMessage)
        Description copied from interface: IActionMonitor
        Post a verbose message to the monitor. Verbose messages are generated for file level actions.
        Specified by:
        verbose in interface IActionMonitor
        Parameters:
        sMessage - The verbose message to display.

      • highLevel

        public void highLevel(java.lang.String sMessage)
        Description copied from interface: IActionMonitor
        Post a high level message to the monitor. High level messages are generated for test asset and directory level actions.
        Specified by:
        highLevel in interface IActionMonitor
        Parameters:
        sMessage - The high level message to display.

      • action

        public void action(java.lang.String sMessage)
        Description copied from interface: IActionMonitor
        Post an action message to the monitor.
        Specified by:
        action in interface IActionMonitor
        Parameters:
        sMessage - The action message to display.

      • getDetailLevel

        public int getDetailLevel()
        Description copied from interface: IActionMonitor
        Suppling the detail level to the interface consumer is an optimization that allows the consumer to avoid generating potentially expensive messages that will not be utilized. The result of this message is one of the DETAIL constants defined in this specification.
        Specified by:
        getDetailLevel in interface IActionMonitor
        Returns:
        One of the DETAIL literals.
        See Also:
        NO_DETAIL, ACTION_DETAIL, HIGHLEVEL_DETAIL, VERBOSE_DETAIL

      • beginTask

        public void beginTask(java.lang.String name,
                      int totalWork)
        Description copied from interface: IActionMonitor
        Notifies that the main task is beginning. This must only be called once on a given progress monitor instance.
        Specified by:
        beginTask in interface IActionMonitor
        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 implemenation is free to indicate progress in a way which doesn't require the total number of work units in advance.

      • done

        public void done()
        Description copied from interface: IActionMonitor
        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).
        Specified by:
        done in interface IActionMonitor

      • isCanceled

        public boolean isCanceled()
        Description copied from interface: IActionMonitor
        Returns whether cancelation of current operation has been requested. Long-running operations should poll to see if cancelation has been requested.
        Specified by:
        isCanceled in interface IActionMonitor
        Returns:
        true if cancellation has been requested, and false otherwise
        See Also:
        #setCanceled

      • subTask

        public void subTask(java.lang.String name)
        Description copied from interface: IActionMonitor
        Notifies that a subtask of the main task is beginning. Subtasks are optional; the main task might not have subtasks.
        Specified by:
        subTask in interface IActionMonitor
        Parameters:
        name - the name (or description) of the subtask

      • worked

        public void worked(int work)
        Description copied from interface: IActionMonitor
        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.
        Specified by:
        worked in interface IActionMonitor
        Parameters:
        work - the number of work units just completed
Skip navigation links