Package org.apache.sshd.common.future

Class DefaultCancellableSshFuture<T extends SshFuture<T>>

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.future.AbstractSshFuture<T>

org.apache.sshd.common.future.DefaultSshFuture<T>

org.apache.sshd.common.future.DefaultVerifiableSshFuture<T>

org.apache.sshd.common.future.DefaultCancellableSshFuture<T>

Type Parameters:

T - Type of future

All Implemented Interfaces:

Cancellable, SshFuture<T>, VerifiableFuture<T>, WaitableFuture, WithException

Direct Known Subclasses:

DefaultIoConnectFuture

public abstract class DefaultCancellableSshFuture<T extends SshFuture<T>>
extends DefaultVerifiableSshFuture<T>
implements Cancellable

A default Cancellable future implementation.

Author:

Apache MINA SSHD Project

Field Summary

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultCancellableSshFuture(Object id, Object lock)

Method Summary

Modifier and Type	Method	Description
CancelFuture	cancel()	Attempts to cancel the operation.
protected CancelFuture	createCancellation()	Creates a CancelFuture if this future can be canceled.
CancelFuture	getCancellation()	Retrieves the CancelFuture, if Cancellable.cancel() had been called.
Throwable	getException()	Returns the cause of the failure.
boolean	isCanceled()	Tells whether this operation was canceled.
void	setException(Throwable exception)	Sets the exception that caused the operation to fail.

Methods inherited from class org.apache.sshd.common.future.DefaultSshFuture

addListener, await0, getNumRegisteredListeners, getValue, isDone, notifyListeners, onValueSet, removeListener, setValue, toString

Methods inherited from class org.apache.sshd.common.future.AbstractSshFuture

asListener, asT, await, awaitUninterruptibly, formatExceptionMessage, getId, notifyListener, verifyResult

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.sshd.common.future.VerifiableFuture

verify, verify, verify, verify

Methods inherited from interface org.apache.sshd.common.future.WaitableFuture

await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly

Constructor Detail

DefaultCancellableSshFuture

protected DefaultCancellableSshFuture(Object id,
                                      Object lock)

Method Detail

isCanceled

public boolean isCanceled()

Description copied from interface: Cancellable

Tells whether this operation was canceled.

Specified by:

isCanceled in interface Cancellable

Returns:

true if the operation was cancelled, false otherwise.

createCancellation

protected CancelFuture createCancellation()

Description copied from class: DefaultSshFuture

Creates a CancelFuture if this future can be canceled.

This doesn't cancel this future yet.

Overrides:

createCancellation in class DefaultSshFuture<T extends SshFuture<T>>

Returns:

A CancelFuture that can be used to wait for the cancellation to have been effected, or null if the future cannot be canceled.

cancel

public CancelFuture cancel()

Description copied from interface: Cancellable

Attempts to cancel the operation.

Specified by:

cancel in interface Cancellable

Returns:

A CancelFuture that can be used to wait for the cancellation to have been effected, or null if the future cannot be canceled or is already completed.

getCancellation

public CancelFuture getCancellation()

Description copied from interface: Cancellable

Retrieves the CancelFuture, if Cancellable.cancel() had been called.

Specified by:

getCancellation in interface Cancellable

Returns:

The CancelFuture if the Cancellable has already been canceled, or null otherwise

getException

public Throwable getException()

Description copied from interface: WithException

Returns the cause of the failure.

Specified by:

getException in interface WithException

Returns:

the Throwable of the failure, or null if not failed (yet).

setException

public void setException(Throwable exception)

Sets the exception that caused the operation to fail. If the exception cannot be set but the future is already canceled, the exception will be reported through this future's CancelFuture.

Specified by:

setException in interface WithException

Parameters:

exception - The Throwable to set; must be non-null