com.facebook.buck.core.rules.configsetting

Class ConfigSettingDescription

java.lang.Object

com.facebook.buck.core.rules.configsetting.ConfigSettingDescription

All Implemented Interfaces:

BaseDescription<ConfigSettingArg>, ConfigurationRuleDescription<ConfigSettingArg,ConfigSettingRule>

public class ConfigSettingDescription
extends Object
implements ConfigurationRuleDescription<ConfigSettingArg,ConfigSettingRule>

A description for config_setting.

This rule should be used to create conditions for select statements.

The values parameter is used to list configuration keys (configuration options from .buckconfig in the form section.option) with expected values.

For example:

   config_setting(
      name = "a",
      values = {
        "section.option": "expected_value",
      }
   )
 

Constructor Summary

Constructors

Constructor and Description
ConfigSettingDescription()

Method Summary

Modifier and Type	Method and Description
ConfigSettingRule	createConfigurationRule(ConfigurationRuleResolver configurationRuleResolver, BuildTarget buildTarget, DependencyStack dependencyStack, ConfigSettingArg arg) Creates a ConfigurationRule
com.google.common.collect.ImmutableSet<BuildTarget>	getConfigurationDeps(ConfigSettingArg arg)
Class<ConfigSettingArg>	getConstructorArgType() The type of the constructor argument that is used by this description to create a rule
Class<ConfigSettingRule>	getRuleClass() Reified type parameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigSettingDescription

public ConfigSettingDescription()

Method Detail

getConstructorArgType

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

getRuleClass

public Class<ConfigSettingRule> getRuleClass()

Description copied from interface: ConfigurationRuleDescription

Reified type parameter

Specified by:

getRuleClass in interface ConfigurationRuleDescription<ConfigSettingArg,ConfigSettingRule>

createConfigurationRule

public ConfigSettingRule createConfigurationRule(ConfigurationRuleResolver configurationRuleResolver,
                                                 BuildTarget buildTarget,
                                                 DependencyStack dependencyStack,
                                                 ConfigSettingArg arg)

Description copied from interface: ConfigurationRuleDescription

Creates a ConfigurationRule

Specified by:

createConfigurationRule in interface ConfigurationRuleDescription<ConfigSettingArg,ConfigSettingRule>

getConfigurationDeps

public com.google.common.collect.ImmutableSet<BuildTarget> getConfigurationDeps(ConfigSettingArg arg)

Specified by:

getConfigurationDeps in interface BaseDescription<ConfigSettingArg>

Returns:

a set of configuration targets declared in a given constructor argument.