com.facebook.buck.shell

Class BaseGenrule<T extends GenruleBuildable>

java.lang.Object

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

com.facebook.buck.rules.modern.ModernBuildRule<T>

com.facebook.buck.shell.BaseGenrule<T>

Type Parameters:

T - Buildable instance for the Genrule implementation.

All Implemented Interfaces:

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

Direct Known Subclasses:

ApkGenrule, ExternallyBuiltApplePackage, Genrule, JarGenrule, JsBundleGenrule

public abstract class BaseGenrule<T extends GenruleBuildable>
extends ModernBuildRule<T>
implements HasOutputName, HasMultipleOutputs

Abstract parent class of all Genrules, containing some common functionality while remaining generic over the Buildable, to be provided by child classes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseGenrule(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, BuildRuleResolver buildRuleResolver, T buildable)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.ImmutableSet<OutputLabel>	getOutputLabels() returns a set of OutputLabel instances associated with this build rule.
String	getOutputName(OutputLabel outputLabel) Get the output name of the generated file, as listed in the BUCK file.
SourcePath	getSourcePathToOutput() Returns the output defined in 'out'.
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() Get whether or not the output of this genrule can be cached.

Methods inherited from class com.facebook.buck.rules.modern.ModernBuildRule

compareTo, getBuildable, getBuildCellPathFactory, getBuildDeps, getBuildSteps, getOutputPathResolver, getSetupStepsForBuildable, getSourcePath, getSourcePaths, injectFieldsIfNecessary, inputBasedRuleKeyIsEnabled, recordOutputs, recordOutputs, recordOutputs, stepsForBuildable, stepsForBuildable, updateBuildRuleResolver

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.BuildRule

compareTo, getBuildDeps, getBuildSteps, 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.attr.SupportsInputBasedRuleKey

isSupported

Constructor Detail

BaseGenrule

protected BaseGenrule(BuildTarget buildTarget,
                      ProjectFilesystem projectFilesystem,
                      BuildRuleResolver buildRuleResolver,
                      T buildable)

Method Detail

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

Returns the output defined in 'out'. Should not be used with multiple outputs. Use getSourcePathToOutput(OutputLabel) instead.

Specified by:

getSourcePathToOutput in interface HasMultipleOutputs

Specified by:

getSourcePathToOutput in interface BuildRule

Overrides:

getSourcePathToOutput in class ModernBuildRule<T extends GenruleBuildable>

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

getType

public String getType()

Specified by:

getType in interface HasNameAndType

Overrides:

getType in class AbstractBuildRule

getOutputName

public String getOutputName(OutputLabel outputLabel)

Get the output name of the generated file, as listed in the BUCK file.

Specified by:

getOutputName in interface HasOutputName

isCacheable

public final boolean isCacheable()

Get whether or not the output of this genrule can be cached.

Specified by:

isCacheable in interface BuildEngineAction

Specified by:

isCacheable in interface BuildRule

Overrides:

isCacheable in class AbstractBuildRule