com.facebook.buck.core.rules.impl

Class AbstractBuildRule

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

Aapt2Link, AaptPackageResources, AbstractBuildRuleWithDeclaredAndExtraDeps, AndroidAppModularity, AndroidAppModularityVerification, AndroidBinary, AndroidBinaryExopackageSymlinkTree, AndroidBinaryNonExoInstaller, AndroidBundle, AndroidManifest, AppleAssetCatalog, AppleBundle, AppleDebuggableBinary, AppleDsym, AssembleDirectories, CGoGenImport, CGoGenSource, CopyNativeLibraries, CxxCompilationDatabase, CxxStrip, DependencyAggregation, DummyRDotJava, ExopackageDeviceDirectoryLister, ExopackageFilesInstaller, ExopackageInstallFinisher, ExopackageResourcesInstaller, ExportFile, GenerateRDotJava, GenerateStringResources, GoTestCoverSource, MergeAndroidResourceSources, MergeAssets, ModernBuildRule, NoopBuildRule, PackageStringAssets, PythonBinary, ResourcesFilter, RuleAnalysisLegacyBuildRuleView, SplitResources, SwiftCompile, SymlinkTree, WriteFile

public abstract class AbstractBuildRule
extends Object
implements BuildRule

Abstract implementation of a BuildRule that can be cached. If its current RuleKey matches the one on disk, then it has no work to do. It should also try to fetch its output from an ArtifactCache to avoid doing any computation.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBuildRule(BuildTarget buildTarget, ProjectFilesystem projectFilesystem)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
BuildTarget	getBuildTarget()
com.google.common.collect.ImmutableSet<BuildTarget>	getDependencies()
ProjectFilesystem	getProjectFilesystem()
com.google.common.collect.ImmutableSet<SourcePath>	getSourcePathOutputs()
String	getType()
boolean	hasBuildSteps() Whether this BuildRule may have any steps to build.
int	hashCode()
protected static void	injectFields(AbstractBuildRule rule, ProjectFilesystem filesystem, BuildTarget target) Allows setting the fields after creation.
boolean	isCacheable() Whether this BuildRule can be cached.
String	toString()
void	updateBuildRuleResolver(BuildRuleResolver ruleResolver) Updates the BuildRuleResolver and associated objects for this build rule.

Methods inherited from class java.lang.Object

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

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

compareTo, getBuildDeps, getBuildSteps, getFullyQualifiedName, getSourcePathToOutput, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Constructor Detail

AbstractBuildRule

protected AbstractBuildRule(BuildTarget buildTarget,
                            ProjectFilesystem projectFilesystem)

Method Detail

injectFields

protected static void injectFields(AbstractBuildRule rule,
                                   ProjectFilesystem filesystem,
                                   BuildTarget target)

Allows setting the fields after creation. Should only be used when deserializing.

getBuildTarget

public final BuildTarget getBuildTarget()

Specified by:

getBuildTarget in interface BuildEngineAction

Specified by:

getBuildTarget in interface BuildRule

Returns:

the BuildTarget of the rule corresponding to this action

getProjectFilesystem

public final ProjectFilesystem getProjectFilesystem()

Specified by:

getProjectFilesystem in interface BuildRule

getType

public String getType()

Specified by:

getType in interface HasNameAndType

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

hasBuildSteps

public boolean hasBuildSteps()

Description copied from interface: BuildRule

Whether this BuildRule may have any steps to build.

Specified by:

hasBuildSteps in interface BuildRule

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

toString

public final String toString()

Specified by:

toString in interface BuildRule

Overrides:

toString in class Object

Returns:

the same value as BuildRule.getFullyQualifiedName()

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

getDependencies

public com.google.common.collect.ImmutableSet<BuildTarget> getDependencies()

Specified by:

getDependencies in interface BuildEngineAction

Returns:

a set of dependencies required for this BuildEngineAction to build, as identified by the BuildTarget.

getSourcePathOutputs

public com.google.common.collect.ImmutableSet<SourcePath> getSourcePathOutputs()

Specified by:

getSourcePathOutputs in interface BuildEngineAction

Returns:

the set of outputs this BuildEngineAction builds. This is here for legacy as BuildRules deal with SourcePath