Jetty 12.0.6 · org.eclipse.jetty.util.FuturePromise · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Throwable	_cause
private final AtomicBoolean	_done
private final CountDownLatch	_latch
private C	_result
private static Throwable	COMPLETED

Access	Constructor and Description
public	FuturePromise()
public	FuturePromise(C result)
public	FuturePromise(C ctx, Throwable failed)

Method Summary

Modifier and Type	Method and Description
public boolean	cancel(boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Attempts to cancel execution of this task.
public void	failed(Throwable the reason for the operation failure cause) Overrides default org.eclipse.jetty.util.Promise.failed. Callback invoked when the operation fails.
public C	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public C	get(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
public C	Returns: the computed result getOrThrow() Return the result if completed successfully or in the case of failure, throw the Exception/Error, or an ExecutionException wrapping the cause if it is neither an Exception or Error.
public boolean	isCancelled() Implements java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally.
public boolean	isDone() Implements java.util.concurrent.Future.isDone. Returns `true` if this task completed.
public static void	rethrow(ExecutionException e)
public void	succeeded(C the context result) Overrides default org.eclipse.jetty.util.Promise.succeeded. Callback invoked when the operation completes.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

_cause	back to summary
private Throwable _cause

_done	back to summary
private final AtomicBoolean _done

_latch	back to summary
private final CountDownLatch _latch

_result	back to summary
private C _result

COMPLETED	back to summary
private static Throwable COMPLETED

FuturePromise	back to summary
public FuturePromise()

FuturePromise	back to summary
public FuturePromise(C result)

FuturePromise	back to summary
public FuturePromise(C ctx, Throwable failed)

Method Detail

cancel back to summary

cancel	back to summary
public boolean cancel(boolean mayInterruptIfRunning) Implements java.util.concurrent.Future.cancel. Doc from java.util.concurrent.Future.cancel. Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when `cancel` is called, this task should never run. If the task has already started, then the `mayInterruptIfRunning` parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task. The return value from this method does not necessarily indicate whether the task is now cancelled; use `isCancelled`. Parameters mayInterruptIfRunning:boolean `true` if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete Returns:boolean `false` if the task could not be cancelled, typically because it has already completed; `true` otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns `true`. Implementations may provide stronger guarantees. Annotations @Override

public boolean cancel(boolean mayInterruptIfRunning)

Implements java.util.concurrent.Future.cancel.

Doc from java.util.concurrent.Future.cancel.

Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.

The return value from this method does not necessarily indicate whether the task is now cancelled; use isCancelled.

Parameters

mayInterruptIfRunning:boolean: true if the thread executing this task should be interrupted (if the thread is known to the implementation); otherwise, in-progress tasks are allowed to complete

Returns:boolean

false if the task could not be cancelled, typically because it has already completed; true otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns true. Implementations may provide stronger guarantees.

Annotations

@Override

failed	back to summary
public void failed(Throwable cause) Overrides default org.eclipse.jetty.util.Promise.failed. Doc from org.eclipse.jetty.util.Promise.failed. Callback invoked when the operation fails. Parameters cause:Throwable the reason for the operation failure Annotations @Override

failed

back to summary

public void failed(Throwable cause)

Overrides default org.eclipse.jetty.util.Promise.failed.

Doc from org.eclipse.jetty.util.Promise.failed.

Callback invoked when the operation fails.

Parameters

cause:Throwable: the reason for the operation failure

Annotations

@Override

get	back to summary
public C get() throws InterruptedException, ExecutionException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result. Returns:C the computed result Annotations @Override Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception

get

back to summary

public C get() throws InterruptedException, ExecutionException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

Returns:C

the computed result

Annotations

@Override

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception

get	back to summary
public C get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:C the computed result Annotations @Override Exceptions InterruptedException: if the current thread was interrupted while waiting ExecutionException: if the computation threw an exception TimeoutException: if the wait timed out

get

back to summary

public C get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:C

the computed result

Annotations

@Override

Exceptions

InterruptedException:: if the current thread was interrupted while waiting
ExecutionException:: if the computation threw an exception
TimeoutException:: if the wait timed out

getOrThrow	back to summary
public C getOrThrow() throws Exception Return the result if completed successfully or in the case of failure, throw the Exception/Error, or an ExecutionException wrapping the cause if it is neither an Exception or Error. Returns:C the computed result Exceptions Exception: if the cause is an Exception or Error, otherwise an ExecutionException wrapping the cause

getOrThrow

back to summary

public C getOrThrow() throws Exception

Return the result if completed successfully or in the case of failure, throw the Exception/Error, or an ExecutionException wrapping the cause if it is neither an Exception or Error.

Returns:C

the computed result

Exceptions

Exception:: if the cause is an Exception or Error, otherwise an ExecutionException wrapping the cause

isCancelled back to summary

isCancelled	back to summary
public boolean isCancelled() Implements java.util.concurrent.Future.isCancelled. Doc from java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally. Returns:boolean `true` if this task was cancelled before it completed Annotations @Override

public boolean isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Doc from java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

Returns:boolean

true if this task was cancelled before it completed

Annotations

@Override

isDone back to summary

isDone	back to summary
public boolean isDone() Implements java.util.concurrent.Future.isDone. Doc from java.util.concurrent.Future.isDone. Returns `true` if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return `true`. Returns:boolean `true` if this task completed Annotations @Override

public boolean isDone()

Implements java.util.concurrent.Future.isDone.

Doc from java.util.concurrent.Future.isDone.

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns:boolean

true if this task completed

Annotations

@Override

rethrow	back to summary
public static void rethrow(ExecutionException e) throws IOException

succeeded	back to summary
public void succeeded(C result) Overrides default org.eclipse.jetty.util.Promise.succeeded. Doc from org.eclipse.jetty.util.Promise.succeeded. Callback invoked when the operation completes. Parameters result:C the context Annotations @Override

succeeded

back to summary

public void succeeded(C result)

Overrides default org.eclipse.jetty.util.Promise.succeeded.

Doc from org.eclipse.jetty.util.Promise.succeeded.

Callback invoked when the operation completes.

Parameters

result:C: the context

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

public Class FuturePromise<C>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail