com.facebook.buck.core.rules.actions

Class AbstractAction

java.lang.Object

com.facebook.buck.core.rules.actions.AbstractAction

All Implemented Interfaces:

BuildEngineAction, Action

Direct Known Subclasses:

CopyAction, RunAction, WriteAction

public abstract class AbstractAction
extends Object
implements Action

Base implementation of an Action

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.collect.ImmutableSortedSet<Artifact>	inputs
protected com.google.common.collect.ImmutableSortedSet<OutputArtifact>	outputs
protected BuildTarget	owner

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAction(ActionRegistry registry, com.google.common.collect.ImmutableSortedSet<Artifact> inputs, com.google.common.collect.ImmutableSortedSet<OutputArtifact> outputs, String shortName)

Method Summary

Modifier and Type	Method and Description
BuildTarget	getBuildTarget()
com.google.common.collect.ImmutableSet<BuildTarget>	getDependencies()
String	getID()
com.google.common.collect.ImmutableSortedSet<Artifact>	getInputs()
com.google.common.collect.ImmutableSortedSet<OutputArtifact>	getOutputs()
BuildTarget	getOwner()
String	getShortName()
com.google.common.collect.ImmutableSortedSet<SourcePath>	getSourcePathOutputs()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.facebook.buck.core.rules.actions.Action

execute, isCacheable, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Field Detail

owner

protected final BuildTarget owner

inputs

protected final com.google.common.collect.ImmutableSortedSet<Artifact> inputs

outputs

protected final com.google.common.collect.ImmutableSortedSet<OutputArtifact> outputs

Constructor Detail

AbstractAction

protected AbstractAction(ActionRegistry registry,
                         com.google.common.collect.ImmutableSortedSet<Artifact> inputs,
                         com.google.common.collect.ImmutableSortedSet<OutputArtifact> outputs,
                         String shortName)

Parameters:

registry - the DefaultActionRegistry to registry this action for.

inputs - the input Artifact for this Action. They can be either outputs of other Actions or be source files

outputs - the outputs for this Action

Method Detail

getOwner

public final BuildTarget getOwner()

Specified by:

getOwner in interface Action

Returns:

the build target of the rule analysis that created of this action

getInputs

public final com.google.common.collect.ImmutableSortedSet<Artifact> getInputs()

Specified by:

getInputs in interface Action

Returns:

the set of inputs required to complete this action

getOutputs

public final com.google.common.collect.ImmutableSortedSet<OutputArtifact> getOutputs()

Specified by:

getOutputs in interface Action

Returns:

the set of outputs this action generates

getSourcePathOutputs

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

Specified by:

getSourcePathOutputs in interface BuildEngineAction

Specified by:

getSourcePathOutputs in interface Action

Returns:

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

getShortName

public final String getShortName()

Specified by:

getShortName in interface Action

Returns:

a name for this action to be printed to console when executing and for logging purposes

getID

public final String getID()

Specified by:

getID in interface Action

Returns:

the short name of this action as an ID

getBuildTarget

public BuildTarget getBuildTarget()

Specified by:

getBuildTarget in interface BuildEngineAction

Returns:

the BuildTarget of the rule corresponding to this action

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.