com.facebook.buck.core.rules.impl

Class RuleAnalysisLegacyBuildRuleView

java.lang.Object

com.facebook.buck.core.rules.impl.AbstractBuildRule

com.facebook.buck.core.rules.impl.RuleAnalysisLegacyBuildRuleView

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasMultipleOutputs, SupportsInputBasedRuleKey, BuildRule, HasNameAndType, Comparable<BuildRule>

Direct Known Subclasses:

RuleAnalysisLegacyBinaryBuildRuleView

public class RuleAnalysisLegacyBuildRuleView
extends AbstractBuildRule
implements SupportsInputBasedRuleKey, HasMultipleOutputs

This represents the RuleAnalysisResult in the modern action framework as a legacy BuildRule so that existing architecture can use them.

TODO(bobyf): figure out how to propagate provider info from here TODO(bobyf): make this a ModernBuildRule

Constructor Summary

Constructors

Constructor and Description
RuleAnalysisLegacyBuildRuleView(String type, BuildTarget buildTarget, Optional<Action> action, BuildRuleResolver ruleResolver, ProjectFilesystem projectFilesystem, ProviderInfoCollection providerInfoCollection)

Method Summary

Modifier and Type	Method and Description
SortedSet<BuildRule>	getBuildDeps()
com.google.common.collect.ImmutableList<? extends Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
com.google.common.collect.ImmutableSet<OutputLabel>	getOutputLabels() returns a set of OutputLabel instances associated with this build rule.
ProviderInfoCollection	getProviderInfos()
SourcePath	getSourcePathToOutput()
com.google.common.collect.ImmutableSortedSet<SourcePath>	getSourcePathToOutput(OutputLabel outputLabel) Returns SourcePath instances to the outputs associated with the given output label, or null if the output label does not exist.
String	getType()
boolean	isCacheable() Whether this BuildRule can be cached.
void	updateBuildRuleResolver(BuildRuleResolver ruleResolver) Updates the BuildRuleResolver and associated objects for this build rule.

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

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, hasBuildSteps, hashCode, injectFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.rules.attr.SupportsInputBasedRuleKey

inputBasedRuleKeyIsEnabled, isSupported

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

compareTo, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString

Methods inherited from interface com.facebook.buck.core.build.action.BuildEngineAction

getDependencies, getSourcePathOutputs

Constructor Detail

RuleAnalysisLegacyBuildRuleView

public RuleAnalysisLegacyBuildRuleView(String type,
                                       BuildTarget buildTarget,
                                       Optional<Action> action,
                                       BuildRuleResolver ruleResolver,
                                       ProjectFilesystem projectFilesystem,
                                       ProviderInfoCollection providerInfoCollection)

Parameters:

type - the type of this BuildRule

buildTarget - the BuildTarget of this analysis rule

action - the action of the result for which we want to provide the BuildRule view

ruleResolver - the current BuildRuleResolver to query dependent rules

projectFilesystem - the filesystem

providerInfoCollection - the providers returned by this build target

Method Detail

getType

public String getType()

Specified by:

getType in interface HasNameAndType

Overrides:

getType in class AbstractBuildRule

getBuildDeps

public SortedSet<BuildRule> getBuildDeps()

Specified by:

getBuildDeps in interface BuildRule

Returns:

the set of rules that must be built before this rule. Normally, this matches the value of the deps argument for this build rule in the build file in which it was defined.

However, there are special cases where other arguments pull in implicit dependencies (e.g., the keystore argument in android_binary). In these cases, the implicit dependencies are also included in the set returned by this method. The value of the original deps argument, as defined in the build file, must be accessed via a custom getter provided by the build rule.

getBuildSteps

public com.google.common.collect.ImmutableList<? extends Step> getBuildSteps(BuildContext context,
                                                                             BuildableContext buildableContext)

Specified by:

getBuildSteps in interface BuildRule

getSourcePathToOutput

@Nullable
public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface HasMultipleOutputs

Specified by:

getSourcePathToOutput in interface BuildRule

getSourcePathToOutput

public com.google.common.collect.ImmutableSortedSet<SourcePath> getSourcePathToOutput(OutputLabel outputLabel)

Description copied from interface: HasMultipleOutputs

Returns SourcePath instances to the outputs associated with the given output label, or null if the output label does not exist. If the default output label is given, returns the default outputs associated with the rule.

Specified by:

getSourcePathToOutput in interface HasMultipleOutputs

getOutputLabels

public com.google.common.collect.ImmutableSet<OutputLabel> getOutputLabels()

Description copied from interface: HasMultipleOutputs

returns a set of OutputLabel instances associated with this build rule.

Specified by:

getOutputLabels in interface HasMultipleOutputs

isCacheable

public boolean isCacheable()

Description copied from interface: BuildRule

Whether this BuildRule can be cached.

Uncached build rules are never written out to cache, never read from cache, and does not count in cache statistics. This rule is useful for artifacts which cannot be easily normalized.

Uncached rules are not always rebuilt, however, as long as the existing on-disk representation is up to date. This means that these rules can take advantage of SupportsInputBasedRuleKey to prevent rebuilding.

Specified by:

isCacheable in interface BuildEngineAction

Specified by:

isCacheable in interface BuildRule

Overrides:

isCacheable in class AbstractBuildRule

updateBuildRuleResolver

public void updateBuildRuleResolver(BuildRuleResolver ruleResolver)

Description copied from interface: BuildRule

Updates the BuildRuleResolver and associated objects for this build rule.

Build rules sometimes hold field references to build rule resolvers. If this build rule is to be cached, it must update its BuildRuleResolver when a new action graph is constructed to avoid leaking the entire action graph it was originally associated with.

Specified by:

updateBuildRuleResolver in interface BuildRule

Overrides:

updateBuildRuleResolver in class AbstractBuildRule

getProviderInfos

public ProviderInfoCollection getProviderInfos()

Returns:

the ProviderInfoCollection returned from rule analysis