Enum PauseStatus

    • Enum Constant Detail

      • SUCCESS

        public static final PauseStatus SUCCESS
        transfer successfully paused (and therefore the return information can be used to resume the transfer later on)
      • NOT_STARTED

        public static final PauseStatus NOT_STARTED
        pause is not yet applicable since transfer has not started; so no action taken
      • CANCELLED_BEFORE_START

        public static final PauseStatus CANCELLED_BEFORE_START
        pause is not yet applicable since transfer has not started AND cancel was requested; so we cancel it
      • NO_EFFECT

        public static final PauseStatus NO_EFFECT
        pause is not possible while transfer is already in progress; so no action taken
      • CANCELLED

        public static final PauseStatus CANCELLED
        pause is not possible while transfer is already in progress AND cancel was requested; so we cancel it
    • Method Detail

      • values

        public static PauseStatus[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (PauseStatus c : PauseStatus.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static PauseStatus valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null
      • isPaused

        public boolean isPaused()
        Returns true if the transfer is paused else false.
      • isCancelled

        public boolean isCancelled()
        Returns true if the transfer is cancelled else false.
      • unchanged

        public boolean unchanged()
        Returns true if the transfer is not started or the pause operation has no effect on the transfer.