public interface ComponentMetadataHandler
Possible uses of component metadata rules are:
Example:
 dependencies {
     components {
         // Set the status and status scheme for every component belonging to a module in the group "org.foo"
         all { ComponentMetadataDetails details ->
             if (details.id.group == "org.foo") {
                 def version = details.id.version
                 // assuming status is last part of version string
                 details.status = version.substring(version.lastIndexOf("-") + 1)
                 details.statusScheme = ["bronze", "silver", "gold", "platinum"]
             }
         }
         // Treat all components in the module "org.foo:bar" as changing
         withModule("org.foo:bar") { ComponentMetadataDetails details ->
             details.changing = true
         }
     }
 }
 | Modifier and Type | Method | Description | 
|---|---|---|
| ComponentMetadataHandler | all(Closure<?> rule) | Adds a rule closure that may modify the metadata of any resolved software component. | 
| ComponentMetadataHandler | all(Class<? extends ComponentMetadataRule> rule) | Adds a class based rule that may modify the metadata of any resolved software component. | 
| ComponentMetadataHandler | all(Class<? extends ComponentMetadataRule> rule,
   Action<? super ActionConfiguration> configureAction) | Adds a class based rule that may modify the metadata of any resolved software component. | 
| ComponentMetadataHandler | all(Object ruleSource) | Adds a rule that may modify the metadata of any resolved software component. | 
| ComponentMetadataHandler | all(Action<? super ComponentMetadataDetails> rule) | Adds a rule action that may modify the metadata of any resolved software component. | 
| ComponentMetadataHandler | withModule(Object id,
          Closure<?> rule) | Adds a rule that may modify the metadata of any resolved software component belonging to the specified module. | 
| ComponentMetadataHandler | withModule(Object id,
          Class<? extends ComponentMetadataRule> rule) | Adds a class based rule that may modify the metadata of any resolved software component belonging to the specified module. | 
| ComponentMetadataHandler | withModule(Object id,
          Class<? extends ComponentMetadataRule> rule,
          Action<? super ActionConfiguration> configureAction) | Adds a class based rule that may modify the metadata of any resolved software component belonging to the specified module. | 
| ComponentMetadataHandler | withModule(Object id,
          Object ruleSource) | Adds a rule that may modify the metadata of any resolved software component belonging to the specified module. | 
| ComponentMetadataHandler | withModule(Object id,
          Action<? super ComponentMetadataDetails> rule) | Adds a rule that may modify the metadata of any resolved software component belonging to the specified module. | 
ComponentMetadataHandler all(Action<? super ComponentMetadataDetails> rule)
rule - the rule to be addedComponentMetadataHandler all(Closure<?> rule)
The supplied rule closure must declare a ComponentMetadataDetails as it's first parameter,
 allowing the component metadata to be modified.
 
In addition, the rule can declare additional (read-only) parameters, which may provide extra details about the component. The order of these additional parameters is not significant.
The following additional parameter types are supported:
IvyModuleDescriptor - additional Ivy-specific
     metadata. Rules declaring this parameter will only be invoked for components packaged as an Ivy module.rule - the rule to be addedComponentMetadataHandler all(Object ruleSource)
The ruleSource is an Object that has a single rule method annotated with Mutate.
 
This rule method:
ComponentMetadataDetails as the first parameter.IvyModuleDescriptor.ruleSource - the rule source object to be added@Incubating ComponentMetadataHandler all(Class<? extends ComponentMetadataRule> rule)
rule - the rule to be added@Incubating ComponentMetadataHandler all(Class<? extends ComponentMetadataRule> rule, Action<? super ActionConfiguration> configureAction)
rule - the rule to be addedconfigureAction - the rule configurationComponentMetadataHandler withModule(Object id, Action<? super ComponentMetadataDetails> rule)
id - the module to apply this rule to in "group:module" format or as a ModuleIdentifierrule - the rule to be addedComponentMetadataHandler withModule(Object id, Closure<?> rule)
The rule closure parameter is subject to the same requirements as all(groovy.lang.Closure).
id - the module to apply this rule to in "group:module" format or as a ModuleIdentifierrule - the rule to be addedComponentMetadataHandler withModule(Object id, Object ruleSource)
The rule source parameter is subject to the same requirements as all(Object).
id - the module to apply this rule to in "group:module" format or as a ModuleIdentifierruleSource - the rule source object to be added@Incubating ComponentMetadataHandler withModule(Object id, Class<? extends ComponentMetadataRule> rule)
id - the module to apply this rule to in "group:module" format or as a ModuleIdentifierrule - the rule to be added@Incubating ComponentMetadataHandler withModule(Object id, Class<? extends ComponentMetadataRule> rule, Action<? super ActionConfiguration> configureAction)
id - the module to apply this rule to in "group:module" format or as a ModuleIdentifierrule - the rule to be added