com.facebook.litho

Class TreeFuture<T extends PotentiallyPartialResult>

java.lang.Object

com.facebook.litho.TreeFuture<T>

Direct Known Subclasses:

LayoutTreeFuture, RenderTreeFuture

public abstract class TreeFuture<T extends PotentiallyPartialResult>
extends java.lang.Object

Base class that wraps a FutureTask to allow calculating the same result across threads.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.RunnableFuture<T>	mFutureTask
protected boolean	mMoveOperationsBetweenThreads
protected java.util.concurrent.atomic.AtomicInteger	mRunningThreadId

Constructor Summary

Constructors

Constructor and Description
TreeFuture(boolean moveOperationsBetweenThreads)

Method Summary

Modifier and Type	Method and Description
protected Systracer.ArgsBuilder	addSystraceArgs(Systracer.ArgsBuilder argsBuilder) Override to add additional args to a systrace.
protected abstract T	calculate() Calculates a new result for this TreeFuture.
int	getWaitingCount()
abstract boolean	isEquivalentTo(TreeFuture that) Returns true if the provided TreeFuture is equivalent to this one.
protected void	onGetEnd(boolean isTracing) Called after Get is completed.
protected void	onGetStart(boolean isTracing) Called before the future's Get is invoked.
protected void	onWaitEnd(boolean isTracing, boolean errorOccurred) Called after Wait ends.
protected void	onWaitStart(boolean isTracing) Called before Wait starts.
protected abstract T	resumeCalculation(T partialResult) Resumes an interrupted calculation based on a partial result

Methods inherited from class java.lang.Object

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

Field Detail

mRunningThreadId

protected final java.util.concurrent.atomic.AtomicInteger mRunningThreadId

mFutureTask

protected final java.util.concurrent.RunnableFuture<T extends PotentiallyPartialResult> mFutureTask

mMoveOperationsBetweenThreads

protected final boolean mMoveOperationsBetweenThreads

Constructor Detail

TreeFuture

public TreeFuture(boolean moveOperationsBetweenThreads)

Method Detail

calculate

protected abstract T calculate()

Calculates a new result for this TreeFuture.

resumeCalculation

protected abstract T resumeCalculation(T partialResult)

Resumes an interrupted calculation based on a partial result

isEquivalentTo

public abstract boolean isEquivalentTo(TreeFuture that)

Returns true if the provided TreeFuture is equivalent to this one.

getWaitingCount

public int getWaitingCount()

onGetStart

protected void onGetStart(boolean isTracing)

Called before the future's Get is invoked. Will start a trace. Override to implement additional logging before Get, but always call super.

onGetEnd

protected void onGetEnd(boolean isTracing)

Called after Get is completed. Will end a trace. Override to implement additional logging after Get, but always call super.

onWaitStart

protected void onWaitStart(boolean isTracing)

Called before Wait starts. Will start a trace. Override to implement additional logging before Wait, but always call super.

onWaitEnd

protected void onWaitEnd(boolean isTracing,
                         boolean errorOccurred)

Called after Wait ends. Will end a trace. Override to implement additional logging after Wait, but always call super.

addSystraceArgs

protected Systracer.ArgsBuilder addSystraceArgs(Systracer.ArgsBuilder argsBuilder)

Override to add additional args to a systrace. The args will already include the running thread ID.