com.facebook.buck.core.rules.analysis

Interface RuleAnalysisContext

All Superinterfaces:

DependencyOnlyRuleAnalysisContext

All Known Implementing Classes:

RuleAnalysisContextImpl

public interface RuleAnalysisContext
extends DependencyOnlyRuleAnalysisContext

A context that will be supplied to a Description's rule implementation so that the rule analysis can be performed. This context will be used to create the rule's Provider, and register corresponding Actions. Actions will be BuildRules for now, but we will eventually migrate to some other representation of the set of Step.

The RuleAnalysisContext will be very similar to Bazel's com.google.devtools.build.lib.analysis.RuleContext. RuleContext

This will contain information on the configurations of the current rule, information about it's transitive dependencies via Providers and their corresponding InfoInterfaces. It will also offer ways to register Steps.

Method Summary

Modifier and Type	Method and Description
ActionRegistry	actionRegistry()
BuckEventBus	getEventBus()
ProviderInfoCollection	resolveDep(BuildTarget dep) same as resolveDeps(Iterable) but for one dep
Map<BuildTarget,ProviderInfoCollection>	resolveDeps(Iterable<BuildTarget> deps)
Artifact	resolveSrc(SourcePath src) same as resolveSrcs(Iterable) but for one src
com.google.common.collect.ImmutableSortedSet<Artifact>	resolveSrcs(Iterable<SourcePath> srcs)

Method Detail

resolveDeps

Map<BuildTarget,ProviderInfoCollection> resolveDeps(Iterable<BuildTarget> deps)

Specified by:

resolveDeps in interface DependencyOnlyRuleAnalysisContext

Returns:

a map of the ProviderInfoCollection of the providers propagated by each of the dependencies requested.

resolveDep

ProviderInfoCollection resolveDep(BuildTarget dep)

same as resolveDeps(Iterable) but for one dep

Specified by:

resolveDep in interface DependencyOnlyRuleAnalysisContext

resolveSrcs

com.google.common.collect.ImmutableSortedSet<Artifact> resolveSrcs(Iterable<SourcePath> srcs)

Specified by:

resolveSrcs in interface DependencyOnlyRuleAnalysisContext

Returns:

a list of the Artifact of the sources of the providers propagated by each of the source paths requested.

resolveSrc

Artifact resolveSrc(SourcePath src)

same as resolveSrcs(Iterable) but for one src

Specified by:

resolveSrc in interface DependencyOnlyRuleAnalysisContext

actionRegistry

ActionRegistry actionRegistry()

Returns:

the factory for creating Artifacts and registering Actions

getEventBus

BuckEventBus getEventBus()

Returns:

an BuckEventBus for sending stats and printing