com.facebook.buck.apple

Class ApplePackageDescription

java.lang.Object

com.facebook.buck.apple.ApplePackageDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<com.facebook.buck.apple.ApplePackageDescription.AbstractApplePackageDescriptionArg>, BaseDescription<ApplePackageDescriptionArg>, Description<ApplePackageDescriptionArg>, Flavored, DescriptionWithTargetGraph<ApplePackageDescriptionArg>

public class ApplePackageDescription
extends Object
implements DescriptionWithTargetGraph<ApplePackageDescriptionArg>, Flavored, ImplicitDepsInferringDescription<com.facebook.buck.apple.ApplePackageDescription.AbstractApplePackageDescriptionArg>

Constructor Summary

Constructors

Constructor and Description
ApplePackageDescription(ToolchainProvider toolchainProvider, SandboxExecutionStrategy sandboxExecutionStrategy, AppleConfig config)

Method Summary

Modifier and Type	Method and Description
BuildRule	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, ApplePackageDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, com.facebook.buck.apple.ApplePackageDescription.AbstractApplePackageDescriptionArg constructorArg, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder) Propagate the packages's flavors to its dependents.
Optional<com.google.common.collect.ImmutableSet<FlavorDomain<?>>>	flavorDomains(TargetConfiguration toolchainTargetConfiguration)
Class<ApplePackageDescriptionArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
boolean	hasFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors, TargetConfiguration toolchainTargetConfiguration)

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.DescriptionWithTargetGraph

producesCacheableSubgraph

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

getConfigurationDeps

Constructor Detail

ApplePackageDescription

public ApplePackageDescription(ToolchainProvider toolchainProvider,
                               SandboxExecutionStrategy sandboxExecutionStrategy,
                               AppleConfig config)

Method Detail

createBuildRule

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

Description copied from interface: DescriptionWithTargetGraph

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

Specified by:

createBuildRule in interface DescriptionWithTargetGraph<ApplePackageDescriptionArg>

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

Returns:

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

getConstructorArgType

public Class<ApplePackageDescriptionArg> getConstructorArgType()

Description copied from interface: BaseDescription

The type of the constructor argument that is used by this description to create a rule

Specified by:

getConstructorArgType in interface BaseDescription<ApplePackageDescriptionArg>

findDepsForTargetFromConstructorArgs

public void findDepsForTargetFromConstructorArgs(BuildTarget buildTarget,
                                                 CellNameResolver cellRoots,
                                                 com.facebook.buck.apple.ApplePackageDescription.AbstractApplePackageDescriptionArg constructorArg,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder,
                                                 com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder)

Propagate the packages's flavors to its dependents.

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<com.facebook.buck.apple.ApplePackageDescription.AbstractApplePackageDescriptionArg>

flavorDomains

public Optional<com.google.common.collect.ImmutableSet<FlavorDomain<?>>> flavorDomains(TargetConfiguration toolchainTargetConfiguration)

Specified by:

flavorDomains in interface Flavored

hasFlavors

public boolean hasFlavors(com.google.common.collect.ImmutableSet<Flavor> flavors,
                          TargetConfiguration toolchainTargetConfiguration)

Specified by:

hasFlavors in interface Flavored

Parameters:

flavors - The set of Flavors to consider. All must match.

Returns:

Whether a BuildRule of the given Flavor can be created.