public final Enum CancelOption

Class Inheritance

java.lang.Object
java.lang.Object
java.lang.Enum
org.apache.sshd.common.future.CancelOption

A CancelOption defines whether a Cancellable future that is waited upon shall be cancelled if waiting times out or is interrupted.

See Also: VerifiableFuture, WaitableFuture

Field Summary

Modifier and Type	Field and Description
public static final CancelOption	CANCEL_ON_INTERRUPT Indicates that when waiting on a future is interrupted, the future shall be canceled.
public static final CancelOption	CANCEL_ON_TIMEOUT Indicates that when waiting on a future times out, the future shall be canceled.
public static final CancelOption	NO_CANCELLATION Indicates that even if waiting on a future times out or is interrupted, it shall not be canceled.

Constructor Summary

Access	Constructor and Description
private	CancelOption()

Method Summary

Modifier and Type	Method and Description
public static CancelOption	valueOf(String name)
public static CancelOption[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

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

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

NO_CANCELLATION back to summary

NO_CANCELLATION	back to summary
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.

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 Detail

CancelOption	back to summary
private CancelOption()

Method Detail

valueOf	back to summary
public static CancelOption valueOf(String name)

values	back to summary
public static CancelOption[] values()