com.facebook.buck.core.rules.analysis.impl

Class RuleAnalysisComputation

java.lang.Object

com.facebook.buck.core.rules.analysis.impl.RuleAnalysisComputation

All Implemented Interfaces:

GraphComputation<RuleAnalysisKey,RuleAnalysisResult>

public class RuleAnalysisComputation
extends Object
implements GraphComputation<RuleAnalysisKey,RuleAnalysisResult>

The GraphComputation for performing the target graph to provider and action graph transformation.

This represents the stage of Buck where the TargetGraph is transformed into the Provider graph, along with the registered Actions.

Constructor Summary

Constructors

Constructor and Description
RuleAnalysisComputation(TargetGraph targetGraph, BuckEventBus eventBus)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<RuleAnalysisKey>	discoverDeps(RuleAnalysisKey key, ComputationEnvironment env) Compute dependent keys required to compute given key, and a set of dependencies as listed by GraphComputation.discoverPreliminaryDeps(ComputeKey).
com.google.common.collect.ImmutableSet<RuleAnalysisKey>	discoverPreliminaryDeps(RuleAnalysisKey key) Compute dependent keys required to compute given the current key.
ComputationIdentifier<RuleAnalysisResult>	getIdentifier()
RuleAnalysisResult	transform(RuleAnalysisKey key, ComputationEnvironment env) Perform a transformation identified by key Key into a final type Result.

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleAnalysisComputation

public RuleAnalysisComputation(TargetGraph targetGraph,
                               BuckEventBus eventBus)

Method Detail

getIdentifier

public ComputationIdentifier<RuleAnalysisResult> getIdentifier()

Specified by:

getIdentifier in interface GraphComputation<RuleAnalysisKey,RuleAnalysisResult>

Returns:

the identifier of the key for this transformation. This should match ComputeKey.getIdentifier()

transform

public RuleAnalysisResult transform(RuleAnalysisKey key,
                                    ComputationEnvironment env)
                             throws ActionCreationException,
                                    RuleAnalysisException

Description copied from interface: GraphComputation

Perform a transformation identified by key Key into a final type Result. This transformation should be performed synchronously.

Specified by:

transform in interface GraphComputation<RuleAnalysisKey,RuleAnalysisResult>

Parameters:

key - The Key of the requested result

env - The execution environment containing results of keys from GraphComputation.discoverDeps(ComputeKey, ComputationEnvironment) and GraphComputation.discoverPreliminaryDeps(ComputeKey)

Returns:

The result of the transformation

Throws:

ActionCreationException

RuleAnalysisException

discoverPreliminaryDeps

public com.google.common.collect.ImmutableSet<RuleAnalysisKey> discoverPreliminaryDeps(RuleAnalysisKey key)

Description copied from interface: GraphComputation

Compute dependent keys required to compute given the current key. The results of those computations will be available in GraphComputation.discoverDeps(ComputeKey, ComputationEnvironment) as a part of ComputationEnvironment, and GraphComputation.transform(ComputeKey, ComputationEnvironment)

Specified by:

discoverPreliminaryDeps in interface GraphComputation<RuleAnalysisKey,RuleAnalysisResult>

Parameters:

key - the current key to transform

Returns:

a set of keys that the GraphComputation.discoverDeps(ComputeKey, ComputationEnvironment) and GraphComputation.transform(ComputeKey, ComputationEnvironment) of the current key depends on

discoverDeps

public com.google.common.collect.ImmutableSet<RuleAnalysisKey> discoverDeps(RuleAnalysisKey key,
                                                                            ComputationEnvironment env)

Description copied from interface: GraphComputation

Compute dependent keys required to compute given key, and a set of dependencies as listed by GraphComputation.discoverPreliminaryDeps(ComputeKey). The results of those computations will be available in GraphComputation.transform(ComputeKey, ComputationEnvironment) as a part of ComputationEnvironment

Specified by:

discoverDeps in interface GraphComputation<RuleAnalysisKey,RuleAnalysisResult>

Parameters:

key - the current key to transform

env - The execution environment containing results of keys from GraphComputation.discoverPreliminaryDeps(ComputeKey)

Returns:

a set of keys that the transformation of the current key depends on