Guava: Google Core Libraries for Java 33.1.0-jre · com.google.common.util.concurrent.ImmediateFuture

Modifier and Type	Class and Description
pack-priv static class	ImmediateFuture.ImmediateCancelledFuture<V extends @Nullable Object>
pack-priv static class	ImmediateFuture.ImmediateFailedFuture<V extends @Nullable Object>

Modifier and Type	Field and Description
private static final LazyLogger	log
pack-priv static final ListenableFuture<?>	NULL
private final V	value

Access	Constructor and Description
pack-priv	ImmediateFuture(V value)

Method Summary

Modifier and Type	Method and Description
public void	addListener(Runnable the listener to run when the computation is complete listener, Executor the executor to run the listener in executor) Implements com.google.common.util.concurrent.ListenableFuture.addListener. Registers a listener to be run on the given executor.
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 V	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public V	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 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 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

log	back to summary
private static final LazyLogger log

NULL	back to summary
pack-priv static final ListenableFuture<?> NULL

value	back to summary
private final V value Annotations @ParametricNullness

ImmediateFuture	back to summary
pack-priv ImmediateFuture(V value)

Method Detail

addListener back to summary

addListener	back to summary
public void addListener(Runnable listener, Executor executor) Implements com.google.common.util.concurrent.ListenableFuture.addListener. Doc from com.google.common.util.concurrent.ListenableFuture.addListener. Registers a listener to be run on the given executor. The listener will run when the `Future`'s computation is complete or, if the computation is already complete, immediately. There is no guaranteed ordering of execution of listeners, but any listener added through this method is guaranteed to be called once the computation is complete. Exceptions thrown by a listener will be propagated up to the executor. Any exception thrown during `Executor.execute` (e.g., a `RejectedExecutionException` or an exception thrown by direct execution) will be caught and logged. Note If your listener is lightweight -- and will not cause stack overflow by completing more futures or adding more `directExecutor()` listeners inline -- consider `MoreExecutors#directExecutor`. Otherwise, avoid it: See the warnings on the docs for `directExecutor`. This is the most general listener interface. For common operations performed using listeners, see `Futures`. For a simplified but general listener interface, see `addCallback()`. Memory consistency effects: Actions in a thread prior to adding a listener happen-before its execution begins, perhaps in another thread. Guava implementations of `ListenableFuture` promptly release references to listeners after executing them. Parameters listener:Runnable the listener to run when the computation is complete executor:Executor the executor to run the listener in Annotations @Override @SuppressWarnings:CatchingUnchecked

public void addListener(Runnable listener, Executor executor)

Implements com.google.common.util.concurrent.ListenableFuture.addListener.

Doc from com.google.common.util.concurrent.ListenableFuture.addListener.

Registers a listener to be run on the given executor. The listener will run when the Future's computation is complete or, if the computation is already complete, immediately.

There is no guaranteed ordering of execution of listeners, but any listener added through this method is guaranteed to be called once the computation is complete.

Exceptions thrown by a listener will be propagated up to the executor. Any exception thrown during Executor.execute (e.g., a RejectedExecutionException or an exception thrown by direct execution) will be caught and logged.

Note

If your listener is lightweight -- and will not cause stack overflow by completing more futures or adding more directExecutor() listeners inline -- consider MoreExecutors#directExecutor. Otherwise, avoid it: See the warnings on the docs for directExecutor.

This is the most general listener interface. For common operations performed using listeners, see Futures. For a simplified but general listener interface, see addCallback().

Memory consistency effects: Actions in a thread prior to adding a listener happen-before its execution begins, perhaps in another thread.

Guava implementations of ListenableFuture promptly release references to listeners after executing them.

Parameters

listener:Runnable: the listener to run when the computation is complete
executor:Executor: the executor to run the listener in

Annotations

@Override
@SuppressWarnings:CatchingUnchecked

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

get	back to summary
public V get() 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:V the computed result Annotations @Override @ParametricNullness

get

back to summary

public V get()

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:V

the computed result

Annotations

@Override
@ParametricNullness

get	back to summary
public V get(long timeout, TimeUnit unit) throws ExecutionException 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:V the computed result Annotations @Override @ParametricNullness Exceptions ExecutionException: if the computation threw an exception

get

back to summary

public V get(long timeout, TimeUnit unit) throws ExecutionException

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:V

the computed result

Annotations

@Override
@ParametricNullness

Exceptions

ExecutionException:: if the computation threw an exception

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

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. Returns:String a string representation of the object Annotations @Override

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.

Returns:String

a string representation of the object

Annotations

@Override

pack-priv Class ImmediateFuture<V extends @Nullable Object>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class ImmediateFuture.ImmediateCancelledFuture<V extends @Nullable Object>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

pack-priv final Class ImmediateFuture.ImmediateFailedFuture<V extends @Nullable Object>

Constructor Summary

Method Summary

Constructor Detail