gradle/org.gradle.api.artifacts/ComponentMetadataDetails

ComponentMetadataDetails

interface ComponentMetadataDetails : ComponentMetadata, HasConfigurableAttributes<ComponentMetadataDetails> (source)

Describes a resolved component's metadata, which typically originates from a component descriptor (Ivy file, Maven POM). Some parts of the metadata can be changed via metadata rules (see org.gradle.api.artifacts.dsl.ComponentMetadataHandler.

Since

1.8

Functions

addVariant

abstract fun addVariant(name: String, action: Action<in VariantMetadata>)

Add a rule for adding a new empty variant to the component.

abstract fun addVariant(name: String, base: String, action: Action<in VariantMetadata>)

Add a rule for adding a new variant to the component.

allVariants

abstract fun allVariants(action: Action<in VariantMetadata>)

Add a rule for adjusting all variants of a component.

attributes

abstract fun attributes(action: Action<in AttributeContainer>): SELF

Configure the attribute container that provides the attributes associated with this domain object.

belongsTo

abstract fun belongsTo(notation: Any)

Declares that this component belongs to a virtual platform, which should be considered during dependency resolution.

abstract fun belongsTo(notation: Any, virtual: Boolean)

Declares that this component belongs to a platform, which should be considered during dependency resolution.

getAttributes

abstract fun getAttributes(): AttributeContainer

Returns the attributes

getId

abstract fun getId(): ModuleVersionIdentifier

Returns the identifier of the component.

getStatus

abstract fun getStatus(): String

Returns the status of the component.

getStatusScheme

abstract fun getStatusScheme(): List<String>

Returns the status scheme of the component.

isChanging

abstract fun isChanging(): Boolean

Tells whether the component is changing or immutable.

maybeAddVariant

abstract fun maybeAddVariant(name: String, base: String, action: Action<in VariantMetadata>)

This is the lenient version of addVariant.

setChanging

abstract fun setChanging(changing: Boolean)

Sets whether the component is changing or immutable.

setStatus

abstract fun setStatus(status: String)

Sets the status of the component.

setStatusScheme

abstract fun setStatusScheme(statusScheme: List<String>)

Sets the status scheme of the component.

withVariant

abstract fun withVariant(name: String, action: Action<in VariantMetadata>)

Add a rule for adjusting an existing variant of the component.