Modifier and Type	Class and Description
pack-priv static enum	AggregateFuture.ReleaseResourcesReason

Modifier and Type	Field and Description
private final boolean	allMustSucceed
private final boolean	collectsValues
private ImmutableCollection<? extends ListenableFuture<? extends InputT>>	futures The input futures.
private static final Logger	logger

Access	Constructor and Description
pack-priv	AggregateFuture(ImmutableCollection<? extends ListenableFuture<? extends InputT>> futures, boolean allMustSucceed, boolean collectsValues)

Method Summary

Modifier and Type	Method and Description
private static boolean	addCausalChain(Set<Throwable> seen, Throwable param) Adds the chain to the seen set, and returns whether all the chain was new to us.
pack-priv final void	addInitialException(Set<Throwable> seen) Implements abstract com.google.common.util.concurrent.AggregateFutureState.addInitialException. Populates `seen` with the exception that was passed to `setException`.
protected final void	afterDone() Overrides com.google.common.util.concurrent.AbstractFuture.afterDone. Callback method that is called exactly once after the future is completed.
pack-priv abstract void	collectOneValue(int index, InputT returnValue) If `allMustSucceed` is true, called as each future completes; otherwise, if `collectsValues` is true, called for each future when all futures complete.
private void	collectValueFromNonCancelledFuture(int index, Future<? extends InputT> future) Collects the result (success or failure) of one input future.
private void	decrementCountAndMaybeComplete(ImmutableCollection<? extends Future<? extends InputT>> futuresIfNeedToCollectAtCompletion)
pack-priv abstract void	handleAllCompleted()
private void	handleException(Throwable throwable) Fails this future with the given Throwable if `allMustSucceed` is true.
pack-priv final void	init() Must be called at the end of each subclass's constructor.
private static void	log(Throwable throwable)
protected final String	pendingToString() Overrides com.google.common.util.concurrent.AbstractFuture.pendingToString. Provide a human-readable explanation of why this future has not yet completed.
private void	processCompleted(ImmutableCollection<? extends Future<? extends InputT>> futuresIfNeedToCollectAtCompletion)
pack-priv void	releaseResources(AggregateFuture.ReleaseResourcesReason reason) Clears fields that are no longer needed after this future has completed -- or at least all its inputs have completed (more precisely, after `handleAllCompleted()` has been called).

Inherited from com.google.common.util.concurrent.AggregateFutureState:: clearSeenExceptions decrementRemainingAndGet getOrInitSeenExceptions

Field Detail

allMustSucceed	back to summary
private final boolean allMustSucceed

collectsValues	back to summary
private final boolean collectsValues

futures back to summary

futures	back to summary
private ImmutableCollection<? extends ListenableFuture<? extends InputT>> futures The input futures. After `init`, this field is read only by `afterDone()` (to propagate cancellation) and `toString()`. To access the futures' values, `AggregateFuture` attaches listeners that hold references to one or more inputs. And in the case of `CombinedFuture`, the user-supplied callback usually has its own references to inputs. Annotations @CheckForNull

private ImmutableCollection<? extends ListenableFuture<? extends InputT>> futures

The input futures. After init, this field is read only by afterDone() (to propagate cancellation) and toString(). To access the futures' values, AggregateFuture attaches listeners that hold references to one or more inputs. And in the case of CombinedFuture, the user-supplied callback usually has its own references to inputs.

Annotations

@CheckForNull

logger	back to summary
private static final Logger logger

Constructor Detail

AggregateFuture	back to summary
pack-priv AggregateFuture(ImmutableCollection<? extends ListenableFuture<? extends InputT>> futures, boolean allMustSucceed, boolean collectsValues)

Method Detail

addCausalChain	back to summary
private static boolean addCausalChain(Set<Throwable> seen, Throwable param) Adds the chain to the seen set, and returns whether all the chain was new to us.

addInitialException back to summary

addInitialException	back to summary
pack-priv final void addInitialException(Set<Throwable> seen) Implements abstract com.google.common.util.concurrent.AggregateFutureState.addInitialException. Doc from com.google.common.util.concurrent.AggregateFutureState.addInitialException. Populates `seen` with the exception that was passed to `setException`. Annotations @Override

pack-priv final void addInitialException(Set<Throwable> seen)

Implements abstract com.google.common.util.concurrent.AggregateFutureState.addInitialException.

Doc from com.google.common.util.concurrent.AggregateFutureState.addInitialException.

Populates seen with the exception that was passed to setException.

Annotations

@Override

afterDone back to summary

afterDone	back to summary
protected final void afterDone() Overrides com.google.common.util.concurrent.AbstractFuture.afterDone. Doc from com.google.common.util.concurrent.AbstractFuture.afterDone. Callback method that is called exactly once after the future is completed. If `interruptTask` is also run during completion, `afterDone` runs after it. The default implementation of this method in `AbstractFuture` does nothing. This is intended for very lightweight cleanup work, for example, timing statistics or clearing fields. If your task does anything heavier consider, just using a listener with an executor. Annotations @Override

protected final void afterDone()

Overrides com.google.common.util.concurrent.AbstractFuture.afterDone.

Doc from com.google.common.util.concurrent.AbstractFuture.afterDone.

Callback method that is called exactly once after the future is completed.

If interruptTask is also run during completion, afterDone runs after it.

The default implementation of this method in AbstractFuture does nothing. This is intended for very lightweight cleanup work, for example, timing statistics or clearing fields. If your task does anything heavier consider, just using a listener with an executor.

Annotations

@Override

collectOneValue	back to summary
pack-priv abstract void collectOneValue(int index, InputT returnValue) If `allMustSucceed` is true, called as each future completes; otherwise, if `collectsValues` is true, called for each future when all futures complete.

collectValueFromNonCancelledFuture	back to summary
private void collectValueFromNonCancelledFuture(int index, Future<? extends InputT> future) Collects the result (success or failure) of one input future. The input must not have been cancelled. For details on when this is called, see `collectOneValue`.

decrementCountAndMaybeComplete	back to summary
private void decrementCountAndMaybeComplete(ImmutableCollection<? extends Future<? extends InputT>> futuresIfNeedToCollectAtCompletion)

handleAllCompleted	back to summary
pack-priv abstract void handleAllCompleted()

handleException	back to summary
private void handleException(Throwable throwable) Fails this future with the given Throwable if `allMustSucceed` is true. Also, logs the throwable if it is an `Error` or if `allMustSucceed` is `true`, the throwable did not cause this future to fail, and it is the first time we've seen that particular Throwable.

init back to summary

init	back to summary
pack-priv final void init() Must be called at the end of each subclass's constructor. This method performs the "real" initialization; we can't put this in the constructor because, in the case where futures are already complete, we would not initialize the subclass before calling `collectValueFromNonCancelledFuture`. As this is called after the subclass is constructed, we're guaranteed to have properly initialized the subclass.

pack-priv final void init()

Must be called at the end of each subclass's constructor. This method performs the "real" initialization; we can't put this in the constructor because, in the case where futures are already complete, we would not initialize the subclass before calling collectValueFromNonCancelledFuture. As this is called after the subclass is constructed, we're guaranteed to have properly initialized the subclass.

log	back to summary
private static void log(Throwable throwable)

pendingToString	back to summary
protected final String pendingToString() Overrides com.google.common.util.concurrent.AbstractFuture.pendingToString. Doc from com.google.common.util.concurrent.AbstractFuture.pendingToString. Provide a human-readable explanation of why this future has not yet completed. Returns:String null if an explanation cannot be provided (e.g. because the future is done). Annotations @Override @CheckForNull

pendingToString

back to summary

protected final String pendingToString()

Overrides com.google.common.util.concurrent.AbstractFuture.pendingToString.

Doc from com.google.common.util.concurrent.AbstractFuture.pendingToString.

Provide a human-readable explanation of why this future has not yet completed.

Returns:String

null if an explanation cannot be provided (e.g. because the future is done).

Annotations

@Override
@CheckForNull

processCompleted	back to summary
private void processCompleted(ImmutableCollection<? extends Future<? extends InputT>> futuresIfNeedToCollectAtCompletion)

releaseResources back to summary

releaseResources	back to summary
pack-priv void releaseResources(AggregateFuture.ReleaseResourcesReason reason) Clears fields that are no longer needed after this future has completed -- or at least all its inputs have completed (more precisely, after `handleAllCompleted()` has been called). Often called multiple times (that is, both when the inputs complete and when the output completes). This is similar to our proposed `afterCommit` method but not quite the same. See the description of CL 265462958. Annotations @ForOverride @OverridingMethodsMustInvokeSuper

pack-priv void releaseResources(AggregateFuture.ReleaseResourcesReason reason)

Clears fields that are no longer needed after this future has completed -- or at least all its inputs have completed (more precisely, after handleAllCompleted() has been called). Often called multiple times (that is, both when the inputs complete and when the output completes).

This is similar to our proposed afterCommit method but not quite the same. See the description of CL 265462958.

Annotations

@ForOverride
@OverridingMethodsMustInvokeSuper

com.google.common.util.concurrent back to summary

pack-priv final Enum AggregateFuture.ReleaseResourcesReason

Class Inheritance

extends Enum<AggregateFuture.ReleaseResourcesReason>

java.lang.Object
java.lang.Enum
com.google.common.util.concurrent.AggregateFuture.ReleaseResourcesReason

Field Summary

Modifier and Type	Field and Description
public static final AggregateFuture.ReleaseResourcesReason	ALL_INPUT_FUTURES_PROCESSED
public static final AggregateFuture.ReleaseResourcesReason	OUTPUT_FUTURE_DONE

Constructor Summary

Access	Constructor and Description
private	ReleaseResourcesReason()

Method Summary

Modifier and Type	Method and Description
public static AggregateFuture.ReleaseResourcesReason	valueOf(String name)
public static AggregateFuture.ReleaseResourcesReason[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALL_INPUT_FUTURES_PROCESSED	back to summary
public static final AggregateFuture.ReleaseResourcesReason ALL_INPUT_FUTURES_PROCESSED

OUTPUT_FUTURE_DONE	back to summary
public static final AggregateFuture.ReleaseResourcesReason OUTPUT_FUTURE_DONE

Constructor Detail

ReleaseResourcesReason	back to summary
private ReleaseResourcesReason()

Method Detail

valueOf	back to summary
public static AggregateFuture.ReleaseResourcesReason valueOf(String name)

values	back to summary
public static AggregateFuture.ReleaseResourcesReason[] values()

pack-priv abstract Class AggregateFuture<InputT extends @Nullable Object, OutputT extends @Nullable Object>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Enum AggregateFuture.ReleaseResourcesReason

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail