程序包 cn.taketoday.util.concurrent

类 DefaultFuture<V>

java.lang.Object

cn.taketoday.util.concurrent.AbstractFuture<V>

cn.taketoday.util.concurrent.DefaultFuture<V>

所有已实现的接口:

ListenableFuture<V>, SettableFuture<V>, Future<V>

直接已知子类:

DefaultProgressiveFuture, SettableFutureTask

public class DefaultFuture<V>
extends AbstractFuture<V>
implements SettableFuture<V>

Default SettableFuture

从以下版本开始:

4.0 2024/2/26 17:27

作者:

Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static final class	DefaultFuture.CauseHolder
private static final class	DefaultFuture.LeanCancellationException
private static final class	DefaultFuture.StacklessCancellationException

字段概要

字段

修饰符和类型	字段	说明
private static final DefaultFuture.CauseHolder	CANCELLATION_CAUSE_HOLDER
private static final StackTraceElement[]	CANCELLATION_STACK
(专用程序包) static final Executor	defaultExecutor
private final Executor	executor
private FutureListener<? extends ListenableFuture<?>>	listener	One or more listeners.
private FutureListeners	listeners
private static final Logger	logger
private boolean	notifyingListeners	Threading - synchronized(this).
private static final Logger	rejectedExecutionLogger
private Object	result
private static final AtomicReferenceFieldUpdater<DefaultFuture,Object>	RESULT_UPDATER
private static final Object	SUCCESS
private static final Object	UNCANCELLABLE
private short	waiters	Threading - synchronized(this).

构造器概要

构造器

构造器	说明
DefaultFuture()	Creates a new instance.
DefaultFuture(Executor executor)	Creates a new instance.

方法概要

修饰符和类型	方法	说明
SettableFuture<V>	addListener(FutureListener<? extends ListenableFuture<V>> listener)	Adds the specified listener to this future.
SettableFuture<V>	addListeners(FutureListener<? extends ListenableFuture<V>>... listeners)	Adds the specified listeners to this future.
SettableFuture<V>	await()	Waits for this future to be completed.
boolean	await(long timeoutMillis)	Waits for this future to be completed within the specified time limit.
boolean	await(long timeout, TimeUnit unit)	Waits for this future to be completed within the specified time limit.
SettableFuture<V>	awaitUninterruptibly()	Waits for this future to be completed without interruption.
boolean	awaitUninterruptibly(long timeoutMillis)	Waits for this future to be completed within the specified time limit without interruption.
boolean	awaitUninterruptibly(long timeout, TimeUnit unit)	Waits for this future to be completed within the specified time limit without interruption.
boolean	cancel(boolean mayInterruptIfRunning)	If the cancellation was successful it will fail the future with a CancellationException.
private boolean	checkNotifyWaiters()	Check if there are any waiters and if so notify these.
private void	decWaiters()
private void	doAddListener(FutureListener<? extends ListenableFuture<V>> listener)
private boolean	doAwait(long timeoutNanos, boolean interruptable)
private void	doRemoveListener(FutureListener<? extends ListenableFuture<V>> toRemove)
private boolean	doSetFailure(Throwable cause)
private boolean	doSetSuccess(V result)
private boolean	doSetValue(Object objResult)
V	get()
V	get(long timeout, TimeUnit unit)
Throwable	getCause()	Returns the cause of the failed operation if the operation failed.
private Throwable	getCause(Object result)
V	getNow()	Return the result without blocking.
private void	incWaiters()
protected void	interruptTask()	Subclasses can override this method to implement interruption of the future's computation.
boolean	isCancellable()
boolean	isCancelled()
private static boolean	isCancelled(Object result)
boolean	isDone()
private static boolean	isDone(Object result)
boolean	isSuccess()	Returns true if and only if the operation was completed successfully.
private static void	notifyListener(ListenableFuture future, FutureListener l)
protected static void	notifyListener(Executor executor, ListenableFuture<?> future, FutureListener<?> listener)	Notify a listener that a future has completed.
private void	notifyListeners()
private void	notifyListeners(FutureListeners listeners)
private void	notifyListenersNow()
private static void	notifyProgressiveListener(ProgressiveFuture future, ProgressiveFutureListener l, long progress, long total)
(专用程序包) void	notifyProgressiveListeners(long progress, long total)	Notify all progressive listeners.
private static void	notifyProgressiveListeners(ProgressiveFuture<?> future, ProgressiveFutureListener<?>[] listeners, long progress, long total)
private Object	progressiveListeners()	Returns a ProgressiveFutureListener, an array of ProgressiveFutureListener, or null.
SettableFuture<V>	removeListener(FutureListener<? extends ListenableFuture<V>> listener)	Removes the first occurrence of the specified listener from this future.
SettableFuture<V>	removeListeners(FutureListener<? extends ListenableFuture<V>>... listeners)	Removes the first occurrence for each of the listeners from this future.
private void	rethrowIfFailed()
private static void	safeExecute(Executor executor, Runnable task)
SettableFuture<V>	setFailure(Throwable cause)	Marks this future as a failure and notifies all listeners.
SettableFuture<V>	setSuccess(V result)	Marks this future as a success and notifies all listeners.
boolean	setUncancellable()	Make this future impossible to cancel.
SettableFuture<V>	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
SettableFuture<V>	syncUninterruptibly()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
String	toString()
protected StringBuilder	toStringBuilder()
boolean	tryFailure(Throwable cause)	Marks this future as a failure and notifies all listeners.
boolean	trySuccess(V result)	Marks this future as a success and notifies all listeners.

从类继承的方法 cn.taketoday.util.concurrent.AbstractFuture

obtain

从类继承的方法 java.lang.Object

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

从接口继承的方法 cn.taketoday.util.concurrent.ListenableFuture

completable, obtain

从接口继承的方法 cn.taketoday.util.concurrent.SettableFuture

addListener, onFailure, onSuccess

字段详细资料

logger

private static final Logger logger

rejectedExecutionLogger

private static final Logger rejectedExecutionLogger

RESULT_UPDATER

private static final AtomicReferenceFieldUpdater<DefaultFuture,Object> RESULT_UPDATER

SUCCESS

private static final Object SUCCESS

UNCANCELLABLE

private static final Object UNCANCELLABLE

CANCELLATION_CAUSE_HOLDER

private static final DefaultFuture.CauseHolder CANCELLATION_CAUSE_HOLDER

CANCELLATION_STACK

private static final StackTraceElement[] CANCELLATION_STACK

defaultExecutor

static final Executor defaultExecutor

executor

@Nullable
private final Executor executor

result

@Nullable
private volatile Object result

listener

@Nullable
private FutureListener<? extends ListenableFuture<?>> listener

One or more listeners. Can be a FutureListener or a FutureListeners. If null, it means either 1) no listeners were added yet or 2) all listeners were notified. Threading - synchronized(this). We must support adding listeners when there is no Executor.

listeners

@Nullable
private FutureListeners listeners

waiters

private short waiters

Threading - synchronized(this). We are required to hold the monitor to use Java's underlying wait()/notifyAll().

notifyingListeners

private boolean notifyingListeners

Threading - synchronized(this). We must prevent concurrent notification and FIFO listener notification if the executor changes.

构造器详细资料

DefaultFuture

public DefaultFuture()

Creates a new instance.

DefaultFuture

public DefaultFuture(@Nullable
 Executor executor)

Creates a new instance.

参数:

executor - the Executor which is used to notify the SettableFuture once it is complete.

方法详细资料

addListener

public SettableFuture<V> addListener(FutureListener<? extends ListenableFuture<V>> listener)

从接口复制的说明: ListenableFuture

Adds the specified listener to this future.

The specified listener is notified when this future is done. If this future is already completed, the specified listener is notified immediately.

指定者:

addListener 在接口中 ListenableFuture<V>

指定者:

addListener 在接口中 SettableFuture<V>

addListeners

public SettableFuture<V> addListeners(FutureListener<? extends ListenableFuture<V>>... listeners)

从接口复制的说明: ListenableFuture

Adds the specified listeners to this future.

The specified listeners are notified when this future is done. If this future is already completed, the specified listeners are notified immediately.

指定者:

addListeners 在接口中 ListenableFuture<V>

指定者:

addListeners 在接口中 SettableFuture<V>

removeListener

public SettableFuture<V> removeListener(FutureListener<? extends ListenableFuture<V>> listener)

从接口复制的说明: ListenableFuture

Removes the first occurrence of the specified listener from this future.

The specified listener is no longer notified when this future is done. If the specified listener is not associated with this future, this method does nothing and returns silently.

指定者:

removeListener 在接口中 ListenableFuture<V>

指定者:

removeListener 在接口中 SettableFuture<V>

removeListeners

public SettableFuture<V> removeListeners(FutureListener<? extends ListenableFuture<V>>... listeners)

从接口复制的说明: ListenableFuture

Removes the first occurrence for each of the listeners from this future.

The specified listeners are no longer notified when this future is done. If the specified listeners are not associated with this future, this method does nothing and returns silently.

指定者:

removeListeners 在接口中 ListenableFuture<V>

指定者:

removeListeners 在接口中 SettableFuture<V>

setSuccess

public SettableFuture<V> setSuccess(@Nullable
 V result)

从接口复制的说明: SettableFuture

Marks this future as a success and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

指定者:

setSuccess 在接口中 SettableFuture<V>

trySuccess

public boolean trySuccess(@Nullable
 V result)

从接口复制的说明: SettableFuture

Marks this future as a success and notifies all listeners.

指定者:

trySuccess 在接口中 SettableFuture<V>

返回:

true if and only if successfully marked this future as a success. Otherwise false because this future is already marked as either a success or a failure.

setFailure

public SettableFuture<V> setFailure(Throwable cause)

从接口复制的说明: SettableFuture

Marks this future as a failure and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

指定者:

setFailure 在接口中 SettableFuture<V>

tryFailure

public boolean tryFailure(Throwable cause)

从接口复制的说明: SettableFuture

Marks this future as a failure and notifies all listeners.

指定者:

tryFailure 在接口中 SettableFuture<V>

返回:

true if and only if successfully marked this future as a failure. Otherwise false because this future is already marked as either a success or a failure.

setUncancellable

public boolean setUncancellable()

从接口复制的说明: SettableFuture

Make this future impossible to cancel.

指定者:

setUncancellable 在接口中 SettableFuture<V>

返回:

true if and only if successfully marked this future as uncancellable or it is already done without being cancelled. false if this future has been cancelled already.

isSuccess

public boolean isSuccess()

从接口复制的说明: ListenableFuture

Returns true if and only if the operation was completed successfully.

指定者:

isSuccess 在接口中 ListenableFuture<V>

isCancellable

public boolean isCancellable()

指定者:

isCancellable 在接口中 ListenableFuture<V>

返回:

returns true if and only if the operation can be cancelled via ListenableFuture.cancel(boolean).

isCancelled

public boolean isCancelled()

指定者:

isCancelled 在接口中 Future<V>

isDone

public boolean isDone()

指定者:

isDone 在接口中 Future<V>

getCause

public Throwable getCause()

从接口复制的说明: ListenableFuture

Returns the cause of the failed operation if the operation failed.

指定者:

getCause 在接口中 ListenableFuture<V>

返回:

the cause of the failure. null if succeeded or this future is not completed yet.

getCause

@Nullable
private Throwable getCause(@Nullable
 Object result)

sync

public SettableFuture<V> sync()
                       throws InterruptedException

从接口复制的说明: ListenableFuture

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

指定者:

sync 在接口中 ListenableFuture<V>

指定者:

sync 在接口中 SettableFuture<V>

抛出:

InterruptedException

syncUninterruptibly

public SettableFuture<V> syncUninterruptibly()

从接口复制的说明: ListenableFuture

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

指定者:

syncUninterruptibly 在接口中 ListenableFuture<V>

指定者:

syncUninterruptibly 在接口中 SettableFuture<V>

await

public SettableFuture<V> await()
                        throws InterruptedException

从接口复制的说明: ListenableFuture

Waits for this future to be completed.

指定者:

await 在接口中 ListenableFuture<V>

指定者:

await 在接口中 SettableFuture<V>

抛出:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

public SettableFuture<V> awaitUninterruptibly()

从接口复制的说明: ListenableFuture

Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.

指定者:

awaitUninterruptibly 在接口中 ListenableFuture<V>

指定者:

awaitUninterruptibly 在接口中 SettableFuture<V>

await

public boolean await(long timeout,
 TimeUnit unit)
              throws InterruptedException

从接口复制的说明: ListenableFuture

Waits for this future to be completed within the specified time limit.

指定者:

await 在接口中 ListenableFuture<V>

返回:

true if and only if the future was completed within the specified time limit

抛出:

InterruptedException - if the current thread was interrupted

await

public boolean await(long timeoutMillis)
              throws InterruptedException

从接口复制的说明: ListenableFuture

Waits for this future to be completed within the specified time limit.

指定者:

await 在接口中 ListenableFuture<V>

返回:

true if and only if the future was completed within the specified time limit

抛出:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeout,
 TimeUnit unit)

从接口复制的说明: ListenableFuture

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

指定者:

awaitUninterruptibly 在接口中 ListenableFuture<V>

返回:

true if and only if the future was completed within the specified time limit

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

从接口复制的说明: ListenableFuture

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

指定者:

awaitUninterruptibly 在接口中 ListenableFuture<V>

返回:

true if and only if the future was completed within the specified time limit

getNow

public V getNow()

从接口复制的说明: ListenableFuture

Return the result without blocking. If the future is not done yet this will return null.

As it is possible that a null value is used to mark the future as successful you also need to check if the future is really done with Future.isDone() and not rely on the returned null value.

指定者:

getNow 在接口中 ListenableFuture<V>

get

public V get()
      throws InterruptedException,
ExecutionException

指定者:

get 在接口中 Future<V>

覆盖:

get 在类中 AbstractFuture<V>

抛出:

InterruptedException

ExecutionException

get

@Nullable
public V get(long timeout,
 TimeUnit unit)
      throws InterruptedException,
ExecutionException,
TimeoutException

指定者:

get 在接口中 Future<V>

覆盖:

get 在类中 AbstractFuture<V>

抛出:

InterruptedException

ExecutionException

TimeoutException

cancel

public boolean cancel(boolean mayInterruptIfRunning)

If the cancellation was successful it will fail the future with a CancellationException.

指定者:

cancel 在接口中 Future<V>

指定者:

cancel 在接口中 ListenableFuture<V>

参数:

mayInterruptIfRunning - this value has no effect in this implementation.

interruptTask

protected void interruptTask()

Subclasses can override this method to implement interruption of the future's computation. The method is invoked automatically by a successful call to cancel(true).

The default implementation is empty.

toString

public String toString()

覆盖:

toString 在类中 Object

toStringBuilder

protected StringBuilder toStringBuilder()

notifyListener

protected static void notifyListener(@Nullable
 Executor executor,
 ListenableFuture<?> future,
 FutureListener<?> listener)

Notify a listener that a future has completed.

参数:

executor - the executor to use to notify the listener listener.

future - the future that is complete.

listener - the listener to notify.

notifyListeners

private void notifyListeners()

notifyListenersNow

private void notifyListenersNow()

notifyListeners

private void notifyListeners(FutureListeners listeners)

notifyListener

private static void notifyListener(ListenableFuture future,
 FutureListener l)

doAddListener

private void doAddListener(FutureListener<? extends ListenableFuture<V>> listener)

doRemoveListener

private void doRemoveListener(FutureListener<? extends ListenableFuture<V>> toRemove)

doSetSuccess

private boolean doSetSuccess(@Nullable
 V result)

doSetFailure

private boolean doSetFailure(Throwable cause)

doSetValue

private boolean doSetValue(Object objResult)

checkNotifyWaiters

private boolean checkNotifyWaiters()

Check if there are any waiters and if so notify these.

返回:

true if there are any listeners attached to the SettableFuture, false otherwise.

incWaiters

private void incWaiters()

decWaiters

private void decWaiters()

rethrowIfFailed

private void rethrowIfFailed()

doAwait

private boolean doAwait(long timeoutNanos,
 boolean interruptable)
                 throws InterruptedException

抛出:

InterruptedException

notifyProgressiveListeners

void notifyProgressiveListeners(long progress,
 long total)

Notify all progressive listeners.

No attempt is made to ensure notification order if multiple calls are made to this method before the original invocation completes.

This will do an iteration over all listeners to get all of type ProgressiveFutureListeners.

参数:

progress - the new progress.

total - the total progress.

progressiveListeners

@Nullable
private Object progressiveListeners()

Returns a ProgressiveFutureListener, an array of ProgressiveFutureListener, or null.

notifyProgressiveListeners

private static void notifyProgressiveListeners(ProgressiveFuture<?> future,
 ProgressiveFutureListener<?>[] listeners,
 long progress,
 long total)

notifyProgressiveListener

private static void notifyProgressiveListener(ProgressiveFuture future,
 ProgressiveFutureListener l,
 long progress,
 long total)

isCancelled

private static boolean isCancelled(@Nullable
 Object result)

isDone

private static boolean isDone(@Nullable
 Object result)

safeExecute

private static void safeExecute(@Nullable
 Executor executor,
 Runnable task)