com.facebook.buck.core.rules

Interface ActionGraphBuilder

All Superinterfaces:

BuildRuleResolver, SourcePathRuleFinder

All Known Implementing Classes:

AbstractActionGraphBuilder, MultiThreadedActionGraphBuilder, RuleAnalysisCompatibleDelegatingActionGraphBuilder

public interface ActionGraphBuilder
extends BuildRuleResolver

Provides methods to interact with the ActionGraph.

Method Summary

Modifier and Type	Method and Description
<T extends BuildRule> T	addToIndex(T buildRule) Deprecated.
com.google.common.collect.ImmutableSortedMap<BuildTarget,BuildRule>	computeAllIfAbsent(com.google.common.collect.ImmutableMap<BuildTarget,java.util.function.Function<BuildTarget,BuildRule>> mappings)
BuildRule	computeIfAbsent(BuildTarget target, java.util.function.Function<BuildTarget,BuildRule> mappingFunction) Retrieve the BuildRule for the given BuildTarget.
Iterable<BuildRule>	getBuildRules()
Parallelizer	getParallelizer() Returns a parallelizer object that parallelizes if the current BuildRuleResolver supports parallelism.
Iterable<BuildRule>	getSuccessfullyConstructedBuildRules()
void	invalidate() Invalidates this object.
com.google.common.collect.ImmutableSortedSet<BuildRule>	requireAllRules(Iterable<BuildTarget> buildTargets)
<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 interface com.facebook.buck.core.rules.BuildRuleResolver

getAllRules, getRule, getRuleOptional, getRuleOptionalWithType, getRuleWithType

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

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

Method Detail

getBuildRules

Iterable<BuildRule> getBuildRules()

Returns:

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

getSuccessfullyConstructedBuildRules

Iterable<BuildRule> getSuccessfullyConstructedBuildRules()

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

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

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.

Parameters:

target - target with which the BuildRule is associated.

mappingFunction - function to compute the rule.

Returns:

the current value associated with the rule

requireRule

BuildRule requireRule(BuildTarget target)

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.

requireMetadata

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

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>).

addToIndex

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

Deprecated.

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

Please use computeIfAbsent instead

getParallelizer

Parallelizer getParallelizer()

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

invalidate

void invalidate()

Invalidates this object. All future calls will throw InvalidStateException.

requireAllRules

com.google.common.collect.ImmutableSortedSet<BuildRule> requireAllRules(Iterable<BuildTarget> buildTargets)

computeAllIfAbsent

com.google.common.collect.ImmutableSortedMap<BuildTarget,BuildRule> computeAllIfAbsent(com.google.common.collect.ImmutableMap<BuildTarget,java.util.function.Function<BuildTarget,BuildRule>> mappings)

requireRuleFuture

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