Interface ComponentMetadataDetails
- All Superinterfaces:
ComponentMetadata, HasAttributes, HasConfigurableAttributes<ComponentMetadataDetails>
@Incubating
@NonExtensible
public interface ComponentMetadataDetails
extends 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
ComponentMetadataHandler.- Since:
- 1.8
-
Method Summary
Modifier and TypeMethodDescriptionvoidallVariants(Action<? super VariantMetadata> action) Add a rule for adjusting all variants of a component.voidsetChanging(boolean changing) Sets whether the component is changing or immutable.voidSets the status of the component.voidsetStatusScheme(List<String> statusScheme) Sets the status scheme of the component.voidwithVariant(String name, Action<? super VariantMetadata> action) Add a rule for adjusting an existing variant of the component.Methods inherited from interface ComponentMetadata
getId, getStatus, getStatusScheme, isChangingMethods inherited from interface HasAttributes
getAttributesMethods inherited from interface HasConfigurableAttributes
attributes
-
Method Details
-
setChanging
void setChanging(boolean changing) Sets whether the component is changing or immutable.- Parameters:
changing- whether the component is changing or immutable
-
setStatus
Sets the status of the component. Must match one of the values inComponentMetadata.getStatusScheme().- Parameters:
status- the status of the component
-
setStatusScheme
-
withVariant
Add a rule for adjusting an existing variant of the component.- Parameters:
name- name of the variant to adjust (e.g. 'compile')action- the action to modify the variant- Since:
- 4.4
-
allVariants
Add a rule for adjusting all variants of a component.- Parameters:
action- the action to be executed on each variant.- Since:
- 4.5
-