org.gradle.api.artifacts.dsl

Interface ComponentMetadataHandler

@Incubating
public interface ComponentMetadataHandler

Allows to modify the metadata of depended-on software components.

Example:

 dependencies {
     components {
         eachComponent { 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"]
             }
         }
     }
 }
 

Since:

1.8

Method Summary

Methods

Modifier and Type	Method and Description
void	eachComponent(Action<? super ComponentMetadataDetails> rule) Adds a rule to modify the metadata of depended-on software components.
void	eachComponent(Closure<?> rule) Adds a rule to modify the metadata of depended-on software components.

Method Detail

eachComponent

void eachComponent(Action<? super ComponentMetadataDetails> rule)

Adds a rule to modify the metadata of depended-on software components. For example, this allows to set a component's status and status scheme from within the build script, overriding any value specified in the component descriptor.

Parameters:

rule - the rule to be added

eachComponent

void eachComponent(Closure<?> rule)

Adds a rule to modify the metadata of depended-on software components. For example, this allows to set a component's status and status scheme from within the build script, overriding any value specified in the component descriptor.

The rule can declare one or multiple parameters, depending on which metadata it is interested in. The order of parameters is irrelevant. The following parameter types are supported:

• ComponentMetadataDetails Core metadata which is provided for every kind of component. When declaring this parameter, the type may be omitted.
• IvyModuleMetadata Additional Ivy-specific metadata. Rules declaring this parameter will only be invoked for Ivy components.

Parameters:

rule - the rule to be added