ComponentMetadataHandler

API Documentation:ComponentMetadataHandler

Note: This class is incubating and may change in a future version of Gradle.

Allows the build to provide rules that modify the metadata of depended-on software components.

Possible uses of component metadata rules are:

  • Setting the status and status scheme of a component, overriding the value specified in the component descriptor.
  • Declaring whether or not a component is 'changing', thus impacting the cache behaviour of the component.

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
        }
    }
}

Properties

No properties

Methods

MethodDescription
all(rule)
Incubating

Adds a rule closure that may modify the metadata of any resolved software component.

all(rule)
Incubating

Adds a class based rule that may modify the metadata of any resolved software component.

all(rule, configureAction)
Incubating

Adds a class based rule that may modify the metadata of any resolved software component. The rule itself is configured by the provided configure action.

all(ruleSource)
Incubating

Adds a rule that may modify the metadata of any resolved software component.

all(rule)
Incubating

Adds a rule action that may modify the metadata of any resolved software component.

withModule(id, rule)
Incubating

Adds a rule that may modify the metadata of any resolved software component belonging to the specified module.

withModule(id, rule)
Incubating

Adds a class based rule that may modify the metadata of any resolved software component belonging to the specified module.

withModule(id, rule, configureAction)
Incubating

Adds a class based rule that may modify the metadata of any resolved software component belonging to the specified module.

withModule(id, ruleSource)
Incubating

Adds a rule that may modify the metadata of any resolved software component belonging to the specified module.

withModule(id, rule)
Incubating

Adds a rule that may modify the metadata of any resolved software component belonging to the specified module.

Script blocks

No script blocks

Method details

Note: This method is incubating and may change in a future version of Gradle.

Adds a rule closure that may modify the metadata of any resolved software component.

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.

Note: This method is incubating and may change in a future version of Gradle.

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)

Note: This method is incubating and may change in a future version of Gradle.

Adds a class based rule that may modify the metadata of any resolved software component. The rule itself is configured by the provided configure action.

Note: This method is incubating and may change in a future version of Gradle.

Adds a rule that may modify the metadata of any resolved software component.

The ruleSource is an Object that has a single rule method annotated with Mutate.

This rule method:

Note: This method is incubating and may change in a future version of Gradle.

Adds a rule action that may modify the metadata of any resolved software component.

ComponentMetadataHandler withModule(Object id, Closure<?> rule)

Note: This method is incubating and may change in a future version of Gradle.

Adds a rule that may modify the metadata of any resolved software component belonging to the specified module.

The rule closure parameter is subject to the same requirements as ComponentMetadataHandler.all(groovy.lang.Closure).

Note: This method is incubating and may change in a future version of Gradle.

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)

Note: This method is incubating and may change in a future version of Gradle.

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)

Note: This method is incubating and may change in a future version of Gradle.

Adds a rule that may modify the metadata of any resolved software component belonging to the specified module.

The rule source parameter is subject to the same requirements as ComponentMetadataHandler.all(java.lang.Object).

Note: This method is incubating and may change in a future version of Gradle.

Adds a rule that may modify the metadata of any resolved software component belonging to the specified module.