Class Cancellable

    • Constructor Detail

      • Cancellable

        public Cancellable()
    • 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