com.facebook.buck.core.rules

Interface DescriptionWithTargetGraph<T extends BuildRuleArg>

Type Parameters:

T - The object describing the parameters to be passed to the BuildRule. How this is processed is described in the class level javadoc of ConstructorArgMarshaller.

All Superinterfaces:

BaseDescription<T>, Description<T>

All Known Subinterfaces:

JsBundleOutputsDescription<T>, LegacyProviderCompatibleDescription<T>, VersionPropagator<A>, VersionRoot<A>

All Known Implementing Classes:

AbstractGenruleDescription, AndroidAarDescription, AndroidAppModularityDescription, AndroidBinaryDescription, AndroidBuildConfigDescription, AndroidBundleDescription, AndroidInstrumentationApkDescription, AndroidInstrumentationTestDescription, AndroidLibraryDescription, AndroidManifestDescription, AndroidPrebuiltAarDescription, AndroidResourceDescription, ApkGenruleDescription, AppleAssetCatalogDescription, AppleBinaryDescription, AppleBundleDescription, AppleLibraryDescription, ApplePackageDescription, AppleResourceDescription, AppleTestDescription, AppleToolchainDescription, AppleToolchainSetDescription, CgoLibraryDescription, CommandAliasDescription, CoreDataModelDescription, CsharpLibraryDescription, CxxBinaryDescription, CxxGenruleDescription, CxxLibraryDescription, CxxLuaExtensionDescription, CxxPrecompiledHeaderDescription, CxxPythonExtensionDescription, CxxTestDescription, CxxToolchainDescription, DBinaryDescription, DLibraryDescription, DTestDescription, ExportFileDescription, ExternalTestRunnerDescription, FilegroupDescription, GenAidlDescription, GenruleDescription, GoBinaryDescription, GoLibraryDescription, GoTestDescription, GoTestRunnerDescription, GroovyLibraryDescription, GroovyTestDescription, GwtBinaryDescription, HalideLibraryDescription, HaskellBinaryDescription, HaskellGhciDescription, HaskellHaddockDescription, HaskellLibraryDescription, HaskellPrebuiltLibraryDescription, HttpArchiveDescription, HttpFileDescription, JarGenruleDescription, JavaAnnotationProcessorDescription, JavaBinaryDescription, JavaLibraryDescription, JavaPluginDescription, JavaTestDescription, JavaTestRunnerDescription, JsBundleDescription, JsBundleGenruleDescription, JsLibraryDescription, KeystoreDescription, KotlinLibraryDescription, KotlinTestDescription, LuaBinaryDescription, LuaLibraryDescription, NdkLibraryDescription, NdkToolchainDescription, OcamlBinaryDescription, OcamlLibraryDescription, PrebuiltAppleFrameworkDescription, PrebuiltCxxLibraryDescription, PrebuiltCxxLibraryGroupDescription, PrebuiltDotnetLibraryDescription, PrebuiltGoLibraryDescription, PrebuiltJarDescription, PrebuiltNativeLibraryDescription, PrebuiltOcamlLibraryDescription, PrebuiltPythonLibraryDescription, PrebuiltRustLibraryDescription, PythonBinaryDescription, PythonLibraryDescription, PythonTestDescription, PythonTestRunnerDescription, RemoteFileDescription, RobolectricTestDescription, RustBinaryDescription, RustLibraryDescription, RustTestDescription, ScalaLibraryDescription, ScalaTestDescription, SceneKitAssetsDescription, ShBinaryDescription, ShTestDescription, SwiftLibraryDescription, SwiftToolchainDescription, TestSuiteDescription, VersionedAliasDescription, WorkerToolDescription, XcodePostbuildScriptDescription, XcodePrebuildScriptDescription, XcodeWorkspaceConfigDescription, ZipFileDescription

public interface DescriptionWithTargetGraph<T extends BuildRuleArg>
extends Description<T>

The Source of Truth about a BuildRule, providing mechanisms to expose the arguments that rules derived from the Buildable take and providing a factory for those BuildRules. It is expected that instances of this class are stateless.

Method Summary

Modifier and Type	Method and Description
BuildRule	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, T args) Create a BuildRule for the given BuildRuleParams.
default boolean	producesCacheableSubgraph() Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.

Methods inherited from interface com.facebook.buck.core.description.BaseDescription

getConfigurationDeps, getConstructorArgType

Method Detail

createBuildRule

BuildRule createBuildRule(BuildRuleCreationContextWithTargetGraph context,
                          BuildTarget buildTarget,
                          BuildRuleParams params,
                          T args)

Create a BuildRule for the given BuildRuleParams. Note that the BuildTarget referred to in the params contains the Flavor to create.

Parameters:

buildTarget -

args - A constructor argument, of type as returned by BaseDescription.getConstructorArgType().

Returns:

The BuildRule that describes the default flavour of the rule being described.

producesCacheableSubgraph

default boolean producesCacheableSubgraph()

Whether or not the build rule subgraph produced by this Description is safe to cache in IncrementalActionGraphGenerator for incremental action graph generation.

Specified by:

producesCacheableSubgraph in interface Description<T extends BuildRuleArg>