com.facebook.buck.apple

Class AppleBundleDescription

java.lang.Object

com.facebook.buck.apple.AppleBundleDescription

All Implemented Interfaces:

ImplicitDepsInferringDescription<com.facebook.buck.apple.AppleBundleDescription.AbstractAppleBundleDescriptionArg>, BaseDescription<AppleBundleDescriptionArg>, Description<AppleBundleDescriptionArg>, MetadataProvidingDescription<AppleBundleDescriptionArg>, Flavored, DescriptionWithTargetGraph<AppleBundleDescriptionArg>

public class AppleBundleDescription
extends Object
implements DescriptionWithTargetGraph<AppleBundleDescriptionArg>, Flavored, ImplicitDepsInferringDescription<com.facebook.buck.apple.AppleBundleDescription.AbstractAppleBundleDescriptionArg>, MetadataProvidingDescription<AppleBundleDescriptionArg>

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.common.collect.ImmutableSet<Flavor>	SUPPORTED_LIBRARY_FLAVORS
static Flavor	WATCH_OS_64_32_FLAVOR
static Flavor	WATCH_OS_FLAVOR
static Flavor	WATCH_SIMULATOR_FLAVOR

Constructor Summary

Constructors

Constructor and Description
AppleBundleDescription(ToolchainProvider toolchainProvider, XCodeDescriptions xcodeDescriptions, AppleBinaryDescription appleBinaryDescription, AppleLibraryDescription appleLibraryDescription, AppleConfig appleConfig, CxxBuckConfig cxxBuckConfig, SwiftBuckConfig swiftBuckConfig)

Method Summary

Modifier and Type	Method and Description
AppleBundle	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, AppleBundleDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
<U> Optional<U>	createMetadata(BuildTarget buildTarget, ActionGraphBuilder graphBuilder, CellPathResolver cellRoots, AppleBundleDescriptionArg args, Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions, Class<U> metadataClass)
void	findDepsForTargetFromConstructorArgs(BuildTarget buildTarget, CellNameResolver cellRoots, com.facebook.buck.apple.AppleBundleDescription.AbstractAppleBundleDescriptionArg constructorArg, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> extraDepsBuilder, com.google.common.collect.ImmutableCollection.Builder<BuildTarget> targetGraphOnlyDepsBuilder) Propagate the bundle's platform, debug symbol and strip flavors to its dependents which are other bundles (e.g.
Optional<com.google.common.collect.ImmutableSet<FlavorDomain<?>>>	flavorDomains(TargetConfiguration toolchainTargetConfiguration)
Class<AppleBundleDescriptionArg>	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

Field Detail

SUPPORTED_LIBRARY_FLAVORS

public static final com.google.common.collect.ImmutableSet<Flavor> SUPPORTED_LIBRARY_FLAVORS

WATCH_OS_FLAVOR

public static final Flavor WATCH_OS_FLAVOR

WATCH_OS_64_32_FLAVOR

public static final Flavor WATCH_OS_64_32_FLAVOR

WATCH_SIMULATOR_FLAVOR

public static final Flavor WATCH_SIMULATOR_FLAVOR

Constructor Detail

AppleBundleDescription

public AppleBundleDescription(ToolchainProvider toolchainProvider,
                              XCodeDescriptions xcodeDescriptions,
                              AppleBinaryDescription appleBinaryDescription,
                              AppleLibraryDescription appleLibraryDescription,
                              AppleConfig appleConfig,
                              CxxBuckConfig cxxBuckConfig,
                              SwiftBuckConfig swiftBuckConfig)

Method Detail

getConstructorArgType

public Class<AppleBundleDescriptionArg> 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<AppleBundleDescriptionArg>

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.

createBuildRule

public AppleBundle createBuildRule(BuildRuleCreationContextWithTargetGraph context,
                                   BuildTarget buildTarget,
                                   BuildRuleParams params,
                                   AppleBundleDescriptionArg 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<AppleBundleDescriptionArg>

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

Returns:

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

findDepsForTargetFromConstructorArgs

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

Propagate the bundle's platform, debug symbol and strip flavors to its dependents which are other bundles (e.g. extensions)

Specified by:

findDepsForTargetFromConstructorArgs in interface ImplicitDepsInferringDescription<com.facebook.buck.apple.AppleBundleDescription.AbstractAppleBundleDescriptionArg>

createMetadata

public <U> Optional<U> createMetadata(BuildTarget buildTarget,
                                      ActionGraphBuilder graphBuilder,
                                      CellPathResolver cellRoots,
                                      AppleBundleDescriptionArg args,
                                      Optional<com.google.common.collect.ImmutableMap<BuildTarget,Version>> selectedVersions,
                                      Class<U> metadataClass)

Specified by:

createMetadata in interface MetadataProvidingDescription<AppleBundleDescriptionArg>