com.facebook.buck.apple

Class XcodePrebuildScriptDescription

java.lang.Object

com.facebook.buck.apple.XcodePrebuildScriptDescription

All Implemented Interfaces:

BaseDescription<XcodeScriptDescriptionArg>, Description<XcodeScriptDescriptionArg>, Flavored, DescriptionWithTargetGraph<XcodeScriptDescriptionArg>

public class XcodePrebuildScriptDescription
extends Object
implements DescriptionWithTargetGraph<XcodeScriptDescriptionArg>, Flavored

Description for an xcode_prebuild_script rule which runs a shell script before the Apple target that depends on it is built.

Example rule:

 xcode_prebuild_script(
   name = 'register_app',
   cmd = 'register_app.sh',
 )
 

This rule is a hack and in the long-term should be replaced with a genrule that works in both Buck and Xcode build. Those rules do nothing when building with Buck.

Constructor Summary

Constructors

Constructor and Description
XcodePrebuildScriptDescription()

Method Summary

Modifier and Type	Method and Description
NoopBuildRuleWithDeclaredAndExtraDeps	createBuildRule(BuildRuleCreationContextWithTargetGraph context, BuildTarget buildTarget, BuildRuleParams params, XcodeScriptDescriptionArg args) Create a BuildRule for the given BuildRuleParams.
Class<XcodeScriptDescriptionArg>	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

Methods inherited from interface com.facebook.buck.core.model.Flavored

flavorDomains

Constructor Detail

XcodePrebuildScriptDescription

public XcodePrebuildScriptDescription()

Method Detail

getConstructorArgType

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

createBuildRule

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

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

Returns:

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

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.