com.facebook.buck.core.rules

Interface BuildRuleResolver

All Superinterfaces:

SourcePathRuleFinder

All Known Subinterfaces:

ActionGraphBuilder

All Known Implementing Classes:

AbstractActionGraphBuilder, AbstractBuildRuleResolver, MultiThreadedActionGraphBuilder, RuleAnalysisCompatibleDelegatingActionGraphBuilder

public interface BuildRuleResolver
extends SourcePathRuleFinder

Provides functions for resolving a BuildTarget to its BuildRule.

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSortedSet<BuildRule>	getAllRules(Iterable<BuildTarget> targets)
BuildRule	getRule(BuildTarget buildTarget) Returns the BuildRule associated with the buildTarget.
Optional<BuildRule>	getRuleOptional(BuildTarget buildTarget) Returns the BuildRule associated with the given BuildTarget if it is already present.
<T> Optional<T>	getRuleOptionalWithType(BuildTarget buildTarget, Class<T> cls) Returns the BuildRule associated with the given BuildTarget if it is already present, casting it to an expected type.
<T> T	getRuleWithType(BuildTarget buildTarget, Class<T> cls) Returns the BuildRule associated with the buildTarget, casting it to an expected type.

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

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

Method Detail

getRuleOptional

Optional<BuildRule> getRuleOptional(BuildTarget buildTarget)

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

getRuleOptionalWithType

<T> Optional<T> getRuleOptionalWithType(BuildTarget buildTarget,
                                        Class<T> cls)

Returns the BuildRule associated with the given BuildTarget if it is already present, casting it to an expected type.

Throws:

HumanReadableException - if the BuildRule is not an instance of the given class.

getRule

BuildRule getRule(BuildTarget buildTarget)

Returns the BuildRule associated with the buildTarget.

Throws:

HumanReadableException - if no BuildRule is associated with the BuildTarget.

getRuleWithType

<T> T getRuleWithType(BuildTarget buildTarget,
                      Class<T> cls)

Returns the BuildRule associated with the buildTarget, casting it to an expected type.

Throws:

HumanReadableException - if no rule is associated with the BuildTarget, or if the rule is not an instance of the given class.

getAllRules

com.google.common.collect.ImmutableSortedSet<BuildRule> getAllRules(Iterable<BuildTarget> targets)