com.facebook.buck.file

Class WriteFile

java.lang.Object

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

com.facebook.buck.file.WriteFile

All Implemented Interfaces:

BuildEngineAction, AllowsNonAnnotatedFields, BuildRule, HasNameAndType, Comparable<BuildRule>

Direct Known Subclasses:

DefaultWorkerToolRule

public class WriteFile
extends AbstractBuildRule

Write a constant to a file.

Constructor Summary

Constructors

Constructor and Description
WriteFile(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, byte[] fileContents, Path output, boolean executable)
WriteFile(BuildTarget buildTarget, ProjectFilesystem projectFilesystem, String fileContents, Path output, boolean executable)

Method Summary

Modifier and Type	Method and Description
SortedSet<BuildRule>	getBuildDeps()
com.google.common.collect.ImmutableList<Step>	getBuildSteps(BuildContext context, BuildableContext buildableContext)
byte[]	getFileContents()
SourcePath	getSourcePathToOutput()

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

equals, getBuildTarget, getDependencies, getProjectFilesystem, getSourcePathOutputs, getType, hasBuildSteps, hashCode, injectFields, isCacheable, 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, getFullyQualifiedName, outputFileCanBeCopied, shouldRespectInputSizeLimitForRemoteExecution

Constructor Detail

WriteFile

public WriteFile(BuildTarget buildTarget,
                 ProjectFilesystem projectFilesystem,
                 String fileContents,
                 Path output,
                 boolean executable)

WriteFile

public WriteFile(BuildTarget buildTarget,
                 ProjectFilesystem projectFilesystem,
                 byte[] fileContents,
                 Path output,
                 boolean executable)

Method Detail

getBuildSteps

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

getSourcePathToOutput

public SourcePath getSourcePathToOutput()

getFileContents

public byte[] getFileContents()

getBuildDeps

public SortedSet<BuildRule> getBuildDeps()

Returns:

the set of rules that must be built before this rule. Normally, this matches the value of the deps argument for this build rule in the build file in which it was defined.

However, there are special cases where other arguments pull in implicit dependencies (e.g., the keystore argument in android_binary). In these cases, the implicit dependencies are also included in the set returned by this method. The value of the original deps argument, as defined in the build file, must be accessed via a custom getter provided by the build rule.