com.facebook.buck.core.build.action

Interface BuildEngineAction

All Known Subinterfaces:

Action, BinaryBuildRule, BuildRule, BuildRuleWithBinary, CxxIntermediateBuildProduct, ExportDependencies, ExternalTestRunnerRule, HasAppleDebugSymbolDeps, HasJavaClassHashes, HasMavenCoordinates, HasMultipleOutputs, HasPostBuildSteps, HasRuntimeDeps, HasSupplementaryOutputs, JavaLibrary, JsBundleOutputs, JsDependenciesOutputs, MavenPublishable, MaybeRequiredForSourceOnlyAbi, OverrideScheduleRule, SupportsDependencyFileRuleKey, SupportsInputBasedRuleKey, SupportsPipelining<T>, TestRule, TestXRule

All Known Implementing Classes:

Aapt2Compile, Aapt2Link, AaptPackageResources, AbstractAction, AbstractBuildRule, AbstractBuildRuleWithDeclaredAndExtraDeps, AndroidAar, AndroidAppModularity, AndroidAppModularityVerification, AndroidBinary, AndroidBinaryExopackageSymlinkTree, AndroidBinaryNonExoInstaller, AndroidBuildConfig, AndroidBundle, AndroidInstrumentationApk, AndroidInstrumentationTest, AndroidLibrary, AndroidManifest, AndroidPrebuiltAar, AndroidResource, AndroidResourceIndex, ApkGenrule, AppleAssetCatalog, AppleBundle, AppleDebuggableBinary, AppleDsym, AppleTest, AppleTestAggregatedDependencies, AppleTestX, AppleToolchainBuildRule, AppleToolchainSetBuildRule, Archive, AssembleDirectories, BaseGenrule, BinaryWrapperRule, BuiltinApplePackage, CalculateClassAbi, CalculateSourceAbi, CalculateSourceAbiFromLibraryTarget, CGoGenImport, CGoGenSource, CGoLibrary, CommandAlias, CompareAbis, CopyAction, CopyNativeLibraries, CoreDataModel, CsharpLibrary, CxxBinary, CxxCompilationDatabase, CxxGenrule, CxxLibraryGroup, CxxLink, CxxLuaExtension, CxxPrecompiledHeaderTemplate, CxxPrefixHeader, CxxPreprocessAndCompile, CxxPythonExtension, CxxStrip, CxxTest, CxxThinLTOIndex, CxxThinLTOOpt, DBinary, DCompileBuildRule, DefaultJavaLibrary, DefaultWorkerToolRule, DependencyAggregation, DexProducedFromJavaLibrary, DLibrary, DTest, DummyRDotJava, ExopackageDeviceDirectoryLister, ExopackageFilesInstaller, ExopackageInstallFinisher, ExopackageResourcesInstaller, ExportFile, ExternallyBuiltApplePackage, ExternalTestRunner, Filegroup, GenAidl, GenerateRDotJava, GenerateStringResources, Genrule, GenruleBinary, GoBinary, GoCompile, GoLibrary, GoTest, GoTestCoverSource, GoTestMain, GoTestRunner, GoTestX, GwtBinary, GwtModule, HalideCompile, HalideLibrary, HaskellBinary, HaskellCompileRule, HaskellGhciRule, HaskellHaddockLibRule, HaskellHaddockRule, HaskellLibrary, HaskellLinkRule, HaskellPackageRule, HeaderSymlinkTree, HeaderSymlinkTreeWithHeaderMap, HeaderSymlinkTreeWithModuleMap, HttpArchive, HttpFile, HttpFileBinary, InferNullsafe, JarFattener, JarGenrule, JavaAnnotationProcessor, JavaBinary, Javadoc, JavaSourceJar, JavaTest, JavaTestRunner, JavaTestX, JsBundle, JsBundleAndroid, JsBundleGenrule, JsDependenciesFile, JsFile, JsLibrary, JsonConcatenate, Keystore, LuaBinary, LuaLibrary, LuaStandaloneBinary, MachoDylibStubRule, MappedSymlinkTree, MavenUberJar, MavenUberJar.SourceJar, MergeAndroidResourceSources, MergeAssets, MergeThirdPartyJarResources, ModernBuildRule, MultiarchFile, NativeLibraryProguardGenerator, NdkLibrary, NdkToolchainBuildRule, NoopBuildRule, NoopBuildRuleWithDeclaredAndExtraDeps, OcamlBinary, OcamlBuild, OcamlCCompile, OcamlClean, OcamlDebugLauncher, OcamlLibrary, OcamlLink, OcamlMLCompile, PackageStringAssets, PipelinedModernBuildRule, PrebuiltAppleFramework, PrebuiltCxxLibrary, PrebuiltCxxLibraryGroupDescription.CustomPrebuiltCxxLibrary, PrebuiltDotnetLibrary, PrebuiltHaskellLibrary, PrebuiltJar, PrebuiltNativeLibrary, PrebuiltPythonLibrary, PreDexMerge, PreDexSingleDexMerge, PreDexSplitDexGroup, PreDexSplitDexMerge, PreInclude, PythonBinary, PythonCompileRule, PythonInPlaceBinary, PythonLibrary, PythonPackagedBinary, PythonSymlinkTree, PythonTest, PythonTestRunner, PythonTestX, RemoteFile, RemoteFileBinary, ResourcesFilter, RobolectricTest, RobolectricTestX, RuleAnalysisLegacyBinaryBuildRuleView, RuleAnalysisLegacyBuildRuleView, RuleAnalysisLegacyTestBuildRuleView, RunAction, RustCompileRule, RustLibrary, RustTest, SceneKitAssets, ShBinary, ShTest, SplitResources, SplitUberRDotJavaJar, StandardJavacPlugin, StripLinkable, SwiftCompile, SwiftToolchainBuildRule, SymlinkTree, TestSuite, UnitTestOptions, UnstrippedNativeLibraries, UnzipAar, WriteAction, WriteFile, WriteFileHashCode, WriteStringTemplateRule, Zip

public interface BuildEngineAction

Interface for marking objects that the BuildEngine can build. Eventually, this will become the Action interface itself. However, we keep this one around for compatibility between existing BuildRules and the new Actions.

Method Summary

Modifier and Type	Method and Description
BuildTarget	getBuildTarget()
com.google.common.collect.ImmutableSet<BuildTarget>	getDependencies()
com.google.common.collect.ImmutableSet<SourcePath>	getSourcePathOutputs()
boolean	isCacheable() Whether this BuildEngineAction can be cached.
default boolean	shouldRespectInputSizeLimitForRemoteExecution()

Method Detail

getBuildTarget

BuildTarget getBuildTarget()

Returns:

the BuildTarget of the rule corresponding to this action

getDependencies

com.google.common.collect.ImmutableSet<BuildTarget> getDependencies()

Returns:

a set of dependencies required for this BuildEngineAction to build, as identified by the BuildTarget.

getSourcePathOutputs

com.google.common.collect.ImmutableSet<SourcePath> getSourcePathOutputs()

Returns:

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

isCacheable

boolean isCacheable()

Whether this BuildEngineAction can be cached.

Uncached build rules are never written out to cache, never read from cache, and does not count in cache statistics. This rule is useful for artifacts which cannot be easily normalized.

shouldRespectInputSizeLimitForRemoteExecution

default boolean shouldRespectInputSizeLimitForRemoteExecution()

Returns:

true if this rule should only be allowed to be executed via Remote Execution if it satisfies input size limits.