com.facebook.buck.core.rules.actions.lib

Class WriteAction

java.lang.Object

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

com.facebook.buck.core.rules.actions.lib.WriteAction

All Implemented Interfaces:

BuildEngineAction, Action

public class WriteAction
extends AbstractAction

Action that writes specified contents to all of the given output Artifacts

Field Summary

Fields inherited from class com.facebook.buck.core.rules.actions.AbstractAction

inputs, outputs, owner

Constructor Summary

Constructors

Constructor and Description
WriteAction(ActionRegistry actionRegistry, com.google.common.collect.ImmutableSortedSet<Artifact> inputs, com.google.common.collect.ImmutableSortedSet<OutputArtifact> outputs, CommandLineArgs contents, boolean isExecutable) Create an instance of WriteAction
WriteAction(ActionRegistry actionRegistry, com.google.common.collect.ImmutableSortedSet<Artifact> inputs, com.google.common.collect.ImmutableSortedSet<OutputArtifact> outputs, String contents, boolean isExecutable) Create an instance of WriteAction

Method Summary

Modifier and Type	Method and Description
ActionExecutionResult	execute(ActionExecutionContext executionContext) Executes this action as part of the build
boolean	isCacheable() TODO(bobyf): should we still have this or should we enforce everything to be cacheable

Methods inherited from class com.facebook.buck.core.rules.actions.AbstractAction

getBuildTarget, getDependencies, getID, getInputs, getOutputs, getOwner, getShortName, 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

outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Constructor Detail

WriteAction

public WriteAction(ActionRegistry actionRegistry,
                   com.google.common.collect.ImmutableSortedSet<Artifact> inputs,
                   com.google.common.collect.ImmutableSortedSet<OutputArtifact> outputs,
                   String contents,
                   boolean isExecutable)

Create an instance of WriteAction

Parameters:

actionRegistry - the DefaultActionRegistry to register this action

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

contents - the contents to write

isExecutable - whether the output is executable

WriteAction

public WriteAction(ActionRegistry actionRegistry,
                   com.google.common.collect.ImmutableSortedSet<Artifact> inputs,
                   com.google.common.collect.ImmutableSortedSet<OutputArtifact> outputs,
                   CommandLineArgs contents,
                   boolean isExecutable)

Create an instance of WriteAction

Parameters:

actionRegistry - the DefaultActionRegistry to register this action

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

contents - the contents to write

isExecutable - whether the output is executable

Method Detail

execute

public ActionExecutionResult execute(ActionExecutionContext executionContext)

Description copied from interface: Action

Executes this action as part of the build

Parameters:

executionContext - a set of information the action can use for execution

Returns:

ActionExecutionResult indicating the status of execution

isCacheable

public boolean isCacheable()

Description copied from interface: Action

TODO(bobyf): should we still have this or should we enforce everything to be cacheable

Returns:

whether the output Artifacts should be cached