Package org.opends.server.types
Class Cancellable
- java.lang.Object
-
- org.opends.server.types.Cancellable
-
- Direct Known Subclasses:
LDIFExportConfig
,LDIFImportConfig
@PublicAPI(stability=VOLATILE, mayInstantiate=true, mayExtend=false, mayInvoke=true) public class Cancellable extends Object
Base for data structures that define configuration for operations.
-
-
Constructor Summary
Constructors Constructor Description Cancellable()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
cancel(LocalizableMessage cancelReason)
Indicates that this operation has been cancelled, and the operation if executing should finish as soon as possible.LocalizableMessage
getCancelReason()
Returns the cancel reason for this operation.boolean
isCancelled()
Indicates whether this operation has been cancelled.String
toString()
-
-
-
Method Detail
-
cancel
public void cancel(LocalizableMessage cancelReason)
Indicates that this operation has been cancelled, and the operation if executing should finish as soon as possible.- Parameters:
cancelReason
- the reason for which this task was cancelled
-
isCancelled
public boolean isCancelled()
Indicates whether this operation has been cancelled.- Returns:
- boolean where true indicates that this operation has been cancelled and if currently executing will finish as soon as possible
-
getCancelReason
public LocalizableMessage getCancelReason()
Returns the cancel reason for this operation.- Returns:
- the cancel reason for this operation
-
-