Enum CancelOption

java.lang.Object
java.lang.Enum<CancelOption>
org.apache.sshd.common.future.CancelOption
All Implemented Interfaces:
Serializable, Comparable<CancelOption>

public enum CancelOption extends Enum<CancelOption>
A CancelOption defines whether a Cancellable future that is waited upon shall be cancelled if waiting times out or is interrupted.
See Also:
  • Enum Constant Details

    • CANCEL_ON_TIMEOUT

      public static final CancelOption CANCEL_ON_TIMEOUT
      Indicates that when waiting on a future times out, the future shall be canceled.
    • CANCEL_ON_INTERRUPT

      public static final CancelOption CANCEL_ON_INTERRUPT
      Indicates that when waiting on a future is interrupted, the future shall be canceled.
    • NO_CANCELLATION

      public static final CancelOption NO_CANCELLATION
      Indicates that even if waiting on a future times out or is interrupted, it shall not be canceled.

      CANCEL_ON_TIMEOUT and CANCEL_ON_INTERRUPT take precedence over this flag. The main purpose of this flag is to be able to call verify(timeout, NO_CANCELLATION) to suppress cancelling a future on time-outs or interrupts altogether. By default, verify(timeout) will cancel the future on both time-outs and interrupts.

  • Constructor Details

    • CancelOption

      private CancelOption()
  • Method Details

    • values

      public static CancelOption[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static CancelOption 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