com.facebook.buck.core.rules.resolver.impl

Class RuleAnalysisCompatibleDelegatingActionGraphBuilder

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRuleResolver

com.facebook.buck.core.rules.resolver.impl.AbstractActionGraphBuilder

com.facebook.buck.core.rules.resolver.impl.RuleAnalysisCompatibleDelegatingActionGraphBuilder

All Implemented Interfaces:

ActionGraphBuilder, RuleAnalysisGraph, BuildRuleResolver, SourcePathRuleFinder

public class RuleAnalysisCompatibleDelegatingActionGraphBuilder
extends AbstractActionGraphBuilder
implements RuleAnalysisGraph

An ActionGraphBuilder that manages both rule analysis computation and the legacy action graph construction.

This builder delegates to the new RuleAnalysisGraph and ActionGraphBuilder as appropriate depending on the rule that is requested.

It satisfies the API of both computations to provide compatibility between them

Constructor Summary

Constructors

Constructor and Description
RuleAnalysisCompatibleDelegatingActionGraphBuilder(TargetNodeToBuildRuleTransformer buildRuleGenerator, java.util.function.Function<TargetNodeToBuildRuleTransformer,ActionGraphBuilder> delegateBuilderConstructor, RuleAnalysisGraph delegateRuleAnalysisComputation)

Method Summary

Modifier and Type	Method and Description
<T extends BuildRule> T	addToIndex(T buildRule) Deprecated.
BuildRule	computeIfAbsent(BuildTarget target, java.util.function.Function<BuildTarget,BuildRule> mappingFunction) Retrieve the BuildRule for the given BuildTarget.
RuleAnalysisResult	get(RuleAnalysisKey lookupKey) Finds the RuleAnalysisResult of the given RuleAnalysisKey, starting computation as necessary.
com.google.common.collect.ImmutableMap<RuleAnalysisKey,RuleAnalysisResult>	getAll(Set<RuleAnalysisKey> lookupKeys) same as RuleAnalysisGraph.get(RuleAnalysisKey) but for multiple RuleAnalysisKeys
Iterable<BuildRule>	getBuildRules()
Parallelizer	getParallelizer() Returns a parallelizer object that parallelizes if the current BuildRuleResolver supports parallelism.
Optional<BuildRule>	getRuleOptional(BuildTarget buildTarget) Returns the BuildRule associated with the given BuildTarget if it is already present.
Iterable<BuildRule>	getSuccessfullyConstructedBuildRules()
void	invalidate() Invalidates this object.
<T> Optional<T>	requireMetadata(BuildTarget target, Class<T> metadataClass) Retrieve a piece of metadata for a target.
BuildRule	requireRule(BuildTarget target) Retrieve the BuildRule for the given BuildTarget.
com.google.common.util.concurrent.ListenableFuture<BuildRule>	requireRuleFuture(BuildTarget target)

Methods inherited from class com.facebook.buck.core.rules.resolver.impl.AbstractActionGraphBuilder

checkRuleIsBuiltForCorrectTarget, computeAllIfAbsent, requireAllRules

Methods inherited from class com.facebook.buck.core.rules.impl.AbstractBuildRuleResolver

filterBuildRuleInputs, filterBuildRuleInputs, filterBuildRuleInputs, filterBuildRuleInputs, getAllRules, getRule, getRule, getRule, getRuleOptionalWithType, getRuleWithType, getSourcePathResolver

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.facebook.buck.core.rules.BuildRuleResolver

getAllRules, getRule, getRuleOptionalWithType, getRuleWithType

Methods inherited from interface com.facebook.buck.core.rules.SourcePathRuleFinder

filterBuildRuleInputs, filterBuildRuleInputs, filterBuildRuleInputs, filterBuildRuleInputs, getRule, getRule, getSourcePathResolver

Constructor Detail

RuleAnalysisCompatibleDelegatingActionGraphBuilder

public RuleAnalysisCompatibleDelegatingActionGraphBuilder(TargetNodeToBuildRuleTransformer buildRuleGenerator,
                                                          java.util.function.Function<TargetNodeToBuildRuleTransformer,ActionGraphBuilder> delegateBuilderConstructor,
                                                          RuleAnalysisGraph delegateRuleAnalysisComputation)

Method Detail

getBuildRules

public Iterable<BuildRule> getBuildRules()

Specified by:

getBuildRules in interface ActionGraphBuilder

Returns:

an unmodifiable view of the rules in the index. Throws an exception if construction fails for any rule.

getSuccessfullyConstructedBuildRules

public Iterable<BuildRule> getSuccessfullyConstructedBuildRules()

Specified by:

getSuccessfullyConstructedBuildRules in interface ActionGraphBuilder

Returns:

an unmodifiable view of the successfully constructed (i.e. didn't throw an exception during construction) rules in the index. Does not throw an exception if construction failed for any rule.

computeIfAbsent

public BuildRule computeIfAbsent(BuildTarget target,
                                 java.util.function.Function<BuildTarget,BuildRule> mappingFunction)

Description copied from interface: ActionGraphBuilder

Retrieve the BuildRule for the given BuildTarget. If no rules are associated with the target, compute the rule using the given supplier and update the mapping.

Specified by:

computeIfAbsent in interface ActionGraphBuilder

Parameters:

target - target with which the BuildRule is associated.

mappingFunction - function to compute the rule.

Returns:

the current value associated with the rule

requireRule

public BuildRule requireRule(BuildTarget target)

Description copied from interface: ActionGraphBuilder

Retrieve the BuildRule for the given BuildTarget. If no rules are associated with the target, compute it by transforming the TargetNode associated with this build target using the TargetNodeToBuildRuleTransformer associated with this instance.

Specified by:

requireRule in interface ActionGraphBuilder

requireRuleFuture

public com.google.common.util.concurrent.ListenableFuture<BuildRule> requireRuleFuture(BuildTarget target)

Specified by:

requireRuleFuture in interface ActionGraphBuilder

Overrides:

requireRuleFuture in class AbstractActionGraphBuilder

requireMetadata

public <T> Optional<T> requireMetadata(BuildTarget target,
                                       Class<T> metadataClass)

Description copied from interface: ActionGraphBuilder

Retrieve a piece of metadata for a target. This metadata is computed via MetadataProvidingDescription.createMetadata(com.facebook.buck.core.model.BuildTarget, com.facebook.buck.core.rules.ActionGraphBuilder, com.facebook.buck.core.cell.CellPathResolver, T, java.util.Optional<com.google.common.collect.ImmutableMap<com.facebook.buck.core.model.BuildTarget, com.facebook.buck.versions.Version>>, java.lang.Class<U>).

Specified by:

requireMetadata in interface ActionGraphBuilder

addToIndex

@Deprecated
public <T extends BuildRule> T addToIndex(T buildRule)

Deprecated.

Description copied from interface: ActionGraphBuilder

Adds to the index a mapping from buildRule's target to itself and returns buildRule.

Please use computeIfAbsent instead

Specified by:

addToIndex in interface ActionGraphBuilder

getParallelizer

public Parallelizer getParallelizer()

Description copied from interface: ActionGraphBuilder

Returns a parallelizer object that parallelizes if the current BuildRuleResolver supports parallelism.

Specified by:

getParallelizer in interface ActionGraphBuilder

invalidate

public void invalidate()

Description copied from interface: ActionGraphBuilder

Invalidates this object. All future calls will throw InvalidStateException.

Specified by:

invalidate in interface ActionGraphBuilder

getRuleOptional

public Optional<BuildRule> getRuleOptional(BuildTarget buildTarget)

Description copied from interface: BuildRuleResolver

Returns the BuildRule associated with the given BuildTarget if it is already present.

Specified by:

getRuleOptional in interface BuildRuleResolver

get

public RuleAnalysisResult get(RuleAnalysisKey lookupKey)

Description copied from interface: RuleAnalysisGraph

Finds the RuleAnalysisResult of the given RuleAnalysisKey, starting computation as necessary. All dependencies required will also be transformed, and cached.

Specified by:

get in interface RuleAnalysisGraph

Parameters:

lookupKey - the RuleAnalysisKey to find the result for

Returns:

the RuleAnalysisResult from analyzing the given RuleAnalysisKey

getAll

public com.google.common.collect.ImmutableMap<RuleAnalysisKey,RuleAnalysisResult> getAll(Set<RuleAnalysisKey> lookupKeys)

Description copied from interface: RuleAnalysisGraph

same as RuleAnalysisGraph.get(RuleAnalysisKey) but for multiple RuleAnalysisKeys

Specified by:

getAll in interface RuleAnalysisGraph