api / org.gradle.api.artifacts / ComponentModuleMetadataDetails

ComponentModuleMetadataDetails

@Incubating interface ComponentModuleMetadataDetails : ComponentModuleMetadata

Contains and allows configuring component module metadata information. For information and examples please see org.gradle.api.artifacts.dsl.ComponentModuleMetadataHandler

Since
2.2

Functions

replacedBy

abstract fun replacedBy(moduleNotation: Any): Unit

Configures a replacement module for this module. A real world example: 'com.google.collections:google-collections' is replaced by 'com.google.guava:guava'. Subsequent invocations of this method replace the previous 'replacedBy' value. For information and examples please see org.gradle.api.artifacts.dsl.ComponentMetadataHandler.

abstract fun replacedBy(moduleNotation: Any, reason: String): Unit

Configures a replacement module for this module and provides an explanation for the replacement. A real world example: 'com.google.collections:google-collections' is replaced by 'com.google.guava:guava'. Subsequent invocations of this method replace the previous 'replacedBy' value. For information and examples please see org.gradle.api.artifacts.dsl.ComponentMetadataHandler.

Inherited Functions

getId

abstract fun getId(): ModuleIdentifier

The identifier of the module.

getReplacedBy

abstract fun getReplacedBy(): ModuleIdentifier

The identifier of module that replaces this module. A real world example: 'com.google.collections:google-collections' is replaced by 'com.google.guava:guava'.