api / org.gradle.api.artifacts / ComponentMetadata

ComponentMetadata

@Incubating interface ComponentMetadata : HasAttributes

Provides a read-only view of a resolved component's metadata, which typically originates from a component descriptor (Ivy file, Maven POM).

Functions

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.

Inherited Functions

getAttributes

abstract fun getAttributes(): AttributeContainer

Returns the attributes

Inheritors

ComponentMetadataDetails

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.