程序包 cn.taketoday.util.concurrent

接口 SettableFuture<V>

所有超级接口:

Future<V>, ListenableFuture<V>

所有已知子接口:

ProgressiveFuture<V>

所有已知实现类:

DefaultFuture, DefaultProgressiveFuture, ListenableFutureTask, SettableFutureTask

public interface SettableFuture<V>
extends ListenableFuture<V>

Special ListenableFuture which is writable.

从以下版本开始:

4.0 2024/2/26 15:57

作者:

Harry Yang

方法概要

修饰符和类型	方法	说明
SettableFuture<V>	addListener(FutureListener<? extends ListenableFuture<V>> listener)	Adds the specified listener to this future.
default SettableFuture<V>	addListener(SuccessCallback<V> successCallback, FailureCallback failureCallback)	Java 8 lambda-friendly alternative with success and failure callbacks.
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.
SettableFuture<V>	awaitUninterruptibly()	Waits for this future to be completed without interruption.
default SettableFuture<V>	onFailure(FailureCallback failureCallback)	Java 8 lambda-friendly alternative with failure callbacks.
default SettableFuture<V>	onSuccess(SuccessCallback<V> successCallback)	Java 8 lambda-friendly alternative with success callbacks.
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.
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.
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.

从接口继承的方法 java.util.concurrent.Future

get, get, isCancelled, isDone

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

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, completable, getCause, getNow, isCancellable, isSuccess, obtain

方法详细资料

setSuccess

SettableFuture<V> setSuccess(@Nullable
 V result)

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

trySuccess

boolean trySuccess(@Nullable
 V result)

Marks this future as a success and notifies all listeners.

返回:

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

SettableFuture<V> setFailure(Throwable cause)

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

tryFailure

boolean tryFailure(Throwable cause)

Marks this future as a failure and notifies all listeners.

返回:

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

boolean setUncancellable()

Make this future impossible to cancel.

返回:

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.

addListener

default SettableFuture<V> addListener(SuccessCallback<V> successCallback,
 @Nullable
 FailureCallback failureCallback)

从接口复制的说明: ListenableFuture

Java 8 lambda-friendly alternative with success and failure callbacks.

指定者:

addListener 在接口中 ListenableFuture<V>

参数:

successCallback - the success callback

failureCallback - the failure callback

onSuccess

default SettableFuture<V> onSuccess(SuccessCallback<V> successCallback)

从接口复制的说明: ListenableFuture

Java 8 lambda-friendly alternative with success callbacks.

指定者:

onSuccess 在接口中 ListenableFuture<V>

参数:

successCallback - the success callback

onFailure

default SettableFuture<V> onFailure(FailureCallback failureCallback)

从接口复制的说明: ListenableFuture

Java 8 lambda-friendly alternative with failure callbacks.

指定者:

onFailure 在接口中 ListenableFuture<V>

参数:

failureCallback - the failure callback

addListener

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>

addListeners

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>

removeListener

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>

removeListeners

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>

await

SettableFuture<V> await()
                 throws InterruptedException

从接口复制的说明: ListenableFuture

Waits for this future to be completed.

指定者:

await 在接口中 ListenableFuture<V>

抛出:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

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>

sync

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>

抛出:

InterruptedException

syncUninterruptibly

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>