com.facebook.buck.shell

Class CommandAlias

java.lang.Object

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

com.facebook.buck.core.rules.impl.NoopBuildRule

com.facebook.buck.shell.CommandAlias

All Implemented Interfaces:

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

public class CommandAlias
extends NoopBuildRule
implements BinaryBuildRule, HasRuntimeDeps

A BinaryBuildRule that wraps other build rules, and can optionally add extra arguments, environment variables, or run different tools per host Platform.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommandAlias.UnsupportedPlatformException Specific runtime exception type that is thrown when trying to run a tool via CommandAlias on a platform that has not been provided.

Constructor Summary

Constructors

Constructor and Description
CommandAlias(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, Optional<BuildRule> genericDelegate, com.google.common.collect.ImmutableSortedMap<Platform,BuildRule> platformDelegates, com.google.common.collect.ImmutableList<Arg> args, com.google.common.collect.ImmutableSortedMap<String,Arg> env, Platform platform)

Method Summary

Modifier and Type	Method and Description
Tool	getExecutableCommand(OutputLabel outputLabel) Command to execute the output of this rule.
java.util.stream.Stream<BuildTarget>	getRuntimeDeps(BuildRuleResolver buildRuleResolver)
boolean	inputBasedRuleKeyIsEnabled()

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

getBuildDeps, getBuildSteps, getSourcePathToOutput, hasBuildSteps, isCacheable

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

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, 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, getBuildSteps, getBuildTarget, getFullyQualifiedName, getProjectFilesystem, getSourcePathToOutput, hasBuildSteps, isCacheable, 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

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

isSupported

Constructor Detail

CommandAlias

public CommandAlias(BuildTarget buildTarget,
                    ProjectFilesystem projectFilesystem,
                    Optional<BuildRule> genericDelegate,
                    com.google.common.collect.ImmutableSortedMap<Platform,BuildRule> platformDelegates,
                    com.google.common.collect.ImmutableList<Arg> args,
                    com.google.common.collect.ImmutableSortedMap<String,Arg> env,
                    Platform platform)

Method Detail

inputBasedRuleKeyIsEnabled

public boolean inputBasedRuleKeyIsEnabled()

Specified by:

inputBasedRuleKeyIsEnabled in interface SupportsInputBasedRuleKey

getRuntimeDeps

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

Specified by:

getRuntimeDeps in interface HasRuntimeDeps

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