org.eclipse.equinox.concurrent.future

Class SingleOperationFuture<ResultType>

java.lang.Object

org.eclipse.equinox.concurrent.future.AbstractFuture<ResultType>

org.eclipse.equinox.concurrent.future.SingleOperationFuture<ResultType>

All Implemented Interfaces:

IFuture<ResultType>, ISafeProgressRunner

Direct Known Subclasses:

SingleOperationListenableFuture

public class SingleOperationFuture<ResultType>
extends AbstractFuture<ResultType>

Future implementation for a single operation.

Subclasses may be created if desired. Note that if subclasses are created, that they should/must be very careful with respect to overriding the synchronized methods in this class.

Since:

1.1

Field Summary

Fields

Modifier and Type	Field and Description
protected IProgressMonitor	progressMonitor

Constructor Summary

Constructors

Constructor and Description
SingleOperationFuture()
SingleOperationFuture(IProgressMonitor progressMonitor)

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel the operation
ResultType	get() Waits if necessary for one or more operations to complete, and then returns result(s).
ResultType	get(long waitTimeInMillis) Waits if necessary for one or more operations to complete, and then returns result(s).
IProgressMonitor	getProgressMonitor() Return a progress monitor for this future.
IStatus	getStatus() Get status for operation.
boolean	hasValue() Returns true if any underlying operation(s) have completed.
boolean	isCanceled() Returns true if this future has been previously canceled, false otherwise.
boolean	isDone() Returns true if all underlying operation(s) have been completed.
void	runWithProgress(IProgressRunnable<?> runnable) This method is not intended to be called by clients.
protected void	set(ResultType newValue)
protected void	setException(java.lang.Throwable ex)

Methods inherited from class java.lang.Object

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

Field Detail

progressMonitor

protected IProgressMonitor progressMonitor

Constructor Detail

SingleOperationFuture

public SingleOperationFuture()

SingleOperationFuture

public SingleOperationFuture(IProgressMonitor progressMonitor)

Method Detail

get

public ResultType get()
               throws java.lang.InterruptedException,
                      OperationCanceledException

Description copied from interface: IFuture

Waits if necessary for one or more operations to complete, and then returns result(s). This method will block until either a) at least one result is available; or b) at least one operation throws an exception.

Returns:

Object result of the asynchronous operation(s)

Throws:

java.lang.InterruptedException - if thread calling this method is interrupted.

OperationCanceledException - if the operation has been canceled via progress monitor #getProgressMonitor().

get

public ResultType get(long waitTimeInMillis)
               throws java.lang.InterruptedException,
                      TimeoutException,
                      OperationCanceledException

Description copied from interface: IFuture

Waits if necessary for one or more operations to complete, and then returns result(s). This method will block until either a) at least one result is available; or b) at least one operation throws an exception.

Parameters:

waitTimeInMillis - the maximum time to wait in milliseconds for the operation(s) to complete.

Returns:

Object result of the asynchronous operation(s)

Throws:

java.lang.InterruptedException - if thread calling this method is interrupted.

TimeoutException - if the given wait time is exceeded without getting result.

OperationCanceledException - if the operation has been canceled via progress monitor #getProgressMonitor().

isDone

public boolean isDone()

Description copied from interface: IFuture

Returns true if all underlying operation(s) have been completed.

If this future represents access to just one operation, then this method and IFuture.hasValue() will always return the same value. That is, when a single operation has a value, it is then considered done/completed and both IFuture.hasValue() and #isDone will return true.

If this future represents multiple operations, then this method will only return true when all of the operations have completed. Until all operations have completed, it will return false.

Completion can be due to normal operation completion, an exception, or user cancellation -- in all of these cases, this method will return true if all underlying operation(s) have been completed.

Returns:

true if all operation(s) have completed in some manner.

runWithProgress

public void runWithProgress(IProgressRunnable<?> runnable)

This method is not intended to be called by clients. Rather it should only be used by IExecutors.

getStatus

public IStatus getStatus()

Description copied from interface: IFuture

Get status for operation. Will return null until at least one operation(s) are complete.

If IFuture.hasValue() returns true, this method will return a non-null IStatus. If IFuture.hasValue() returns false, this method will return null.

Note that the returned IStatus instance may be an IMultiStatus, meaning that multiple operations have completed or are pending completion.

Returns:

IStatus the status of completed operation(s). Will return null if IFuture.hasValue() returns false.

See Also:

IFuture.hasValue()

hasValue

public boolean hasValue()

Description copied from interface: IFuture

Returns true if any underlying operation(s) have completed.

If this future represents access to just one operation, then this method and IFuture.isDone() will always return the same value. That is, when a single operation has a value, it is then considered done/completed and both IFuture.isDone() and this method will return true.

If this future represents multiple operations, then this method will return true when any of the operations have completed. Until the first operation is completed, it will return false.

Returns:

true if any operations represented by this future have completed.

cancel

public boolean cancel()

Description copied from interface: IFuture

Cancel the operation

Returns:

false if the operation could not be canceled, typically because it has already completed normally; true otherwise

setException

protected void setException(java.lang.Throwable ex)

set

protected void set(ResultType newValue)

getProgressMonitor

public IProgressMonitor getProgressMonitor()

Description copied from class: AbstractFuture

Return a progress monitor for this future. Subclasses must override.

Specified by:

getProgressMonitor in class AbstractFuture<ResultType>

Returns:

the progress monitor for this future.

isCanceled

public boolean isCanceled()

Description copied from class: AbstractFuture

Returns true if this future has been previously canceled, false otherwise. Subclasses must override.

Specified by:

isCanceled in class AbstractFuture<ResultType>

Returns:

true if this future has been previously canceled, false otherwise