Package com.perforce.p4java.server.callback.progress

Interface IProgress

  • public interface IProgress
    This interface defines a handler class that provides access to progress indicators from the server. After implementing the IProgress, register the callback to an instance of server via registerProgressCallback() IServer.registerProgressCallback(IProgress) For more details, see
    See Also:
    Client Progress Documentation ClientProgressCallbackTest (module: p4java tests), provides a sample implementation of this interface. Note: The property "enableProgress" should be set to true on the server instance to enable progress callbacks.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void description​(java.lang.String description, ProgressUnit units)
      This method provides a description of the current progress being reported by the server.
      void done​(int fail)
      This method indicates that the current progress reporting sequence is done.
      void init​(ProgressType type)
      This is the initialization method called at the start of a progress reporting sequence by the server
      void total​(long total)
      This method provides the total amount of work to be done for the current progress reporting sequence.
      int update​(long position)
      This method provides updates on the current position of work done for the current progress reporting sequence.

    • Method Detail

      • init

        void init​(ProgressType type)
        This is the initialization method called at the start of a progress reporting sequence by the server
        Parameters:
        type - this indicates the type of progress being reported by server. ProgressType

      • description

        void description​(java.lang.String description,
                 ProgressUnit units)
        This method provides a description of the current progress being reported by the server.
        Parameters:
        description - this is description of the current progress
        units - this indicates the units of progress being reported by server. ProgressUnit

      • total

        void total​(long total)
        This method provides the total amount of work to be done for the current progress reporting sequence.
        Parameters:
        total - this is the total amount of work to be done

      • update

        int update​(long position)
        This method provides updates on the current position of work done for the current progress reporting sequence.
        Parameters:
        position - this is the current position of work done
        Returns:
        an integer value indicating whether to continue (0) or abort (non-zero)

      • done

        void done​(int fail)
        This method indicates that the current progress reporting sequence is done.
        Parameters:
        fail - this indicates whether the progress reporting sequence completed successfully (0) or failed (non-zero)