api / org.gradle.api.artifacts / ComponentMetadataDetails

ComponentMetadataDetails

@Incubating @NonExtensible interface ComponentMetadataDetails : ComponentMetadata, HasConfigurableAttributes<ComponentMetadataDetails>

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

allVariants

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

Add a rule for adjusting all variants of a component.

setChanging

abstract fun setChanging(changing: Boolean): Unit

Sets whether the component is changing or immutable.

setStatus

abstract fun setStatus(status: String): Unit

Sets the status of the component. Must match one of the values in #getStatusScheme().

setStatusScheme

abstract fun setStatusScheme(statusScheme: MutableList<String>): Unit

Sets the status scheme of the component. Values are ordered from least to most mature status.

withVariant

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

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

Inherited Functions

attributes

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

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

getId

abstract fun getId(): ModuleVersionIdentifier

Returns the identifier of the component.

getStatus

abstract fun getStatus(): String

Returns the status of the component. Must match one of the values in #getStatusScheme().

getStatusScheme

abstract fun getStatusScheme(): MutableList<String>

Returns the status scheme of the component. Values are ordered from least to most mature status. Defaults to ["integration", "milestone", "release"].

isChanging

abstract fun isChanging(): Boolean

Tells whether the component is changing or immutable.