org.gradle.api.artifacts.dsl

インタフェース ComponentMetadataHandler

@Incubating
public interface ComponentMetadataHandler

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

Example:

 dependencies {
     components {
         //triggered during dependency resolution, for each component:
         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"]
             }
         }

         //Configuring component module metadata for the entire "google-collections" module,
         // declaring that legacy library was replaced with "guava".
         //This way, Gradle's conflict resolution can use this information and use "guava"
         // in case both libraries appear in the same dependency tree.
         module("com.google.collections:google-collections").replacedBy("com.google.guava:guava")
     }
 }
 

導入されたバージョン:

1.8

メソッドの概要

修飾子とタイプ	メソッドと説明
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.
ComponentModuleMetadataDetails	module(Object moduleNotation) Enables configuring component module metadata.

メソッドの詳細

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.

パラメータ:

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 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 irrelevant.

Presently, 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 added

module

ComponentModuleMetadataDetails module(Object moduleNotation)

Enables configuring component module metadata. This metadata applies to the entire component module (e.g. "group:name", like "org.gradle:gradle-core") regardless of the component version.

 //declaring that google collections are replaced by guava
 //so that conflict resolution can take advantage of this information:
 dependencies.components.module('com.google.collections:google-collections').replacedBy('com.google.guava:guava')
 

パラメータ:

moduleNotation - an identifier of the module. String "group:name", e.g. 'org.gradle:gradle-core' or an instance of ModuleIdentifier

戻り値:

an object that allows querying and configuring metadata of given component module

導入されたバージョン:

2.2