com.facebook.buck.shell

Class ShBinary

java.lang.Object

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

com.facebook.buck.core.rules.impl.AbstractBuildRuleWithDeclaredAndExtraDeps

com.facebook.buck.shell.ShBinary

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, HasDeclaredAndExtraDeps, HasRuntimeDeps, BuildRule, HasNameAndType, BinaryBuildRule, Comparable<BuildRule>

public class ShBinary
extends AbstractBuildRuleWithDeclaredAndExtraDeps
implements BinaryBuildRule, HasRuntimeDeps

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ShBinary(BuildTarget buildTarget, CellPathResolver cellRoots, ProjectFilesystem projectFilesystem, BuildRuleParams params, SourcePath main, com.google.common.collect.ImmutableSet<SourcePath> resources)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
Tool	getExecutableCommand(OutputLabel outputLabel) Command to execute the output of this rule.
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
SourcePath	getSourcePathToOutput()
boolean	isCacheable() Whether this BuildRule can be cached.

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

deprecatedGetExtraDeps, getBuildDeps, getDeclaredDeps, getTargetGraphOnlyDeps

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

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

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, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, hasBuildSteps, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution, toString, updateBuildRuleResolver

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

getDependencies, getSourcePathOutputs

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

getType

Constructor Detail

ShBinary

protected ShBinary(BuildTarget buildTarget,
                   CellPathResolver cellRoots,
                   ProjectFilesystem projectFilesystem,
                   BuildRuleParams params,
                   SourcePath main,
                   com.google.common.collect.ImmutableSet<SourcePath> resources)

Method Detail

getBuildSteps

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

Specified by:

getBuildSteps in interface BuildRule

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Specified by:

getSourcePathToOutput in interface BuildRule

getExecutableCommand

public Tool getExecutableCommand(OutputLabel outputLabel)

Description copied from interface: BinaryBuildRule

Command to execute the output of this rule.

Specified by:

getExecutableCommand in interface BinaryBuildRule

Parameters:

outputLabel - associated with the executable

getRuntimeDeps

public java.util.stream.Stream<BuildTarget> getRuntimeDeps(BuildRuleResolver buildRuleResolver)

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

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