Package org.gradle.api.artifacts
Interface ComponentSelection
-
public interface ComponentSelectionRepresents a tuple of the component selector of a module and a candidate version to be evaluated in a component selection rule.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ModuleComponentIdentifiergetCandidate()Gets the candidate version of the module.<T> TgetDescriptor(java.lang.Class<T> descriptorClass)Used to access a specific descriptor format.ComponentMetadatagetMetadata()Gets the metadata of the component.voidreject(java.lang.String reason)Rejects the candidate for the resolution.
-
-
-
Method Detail
-
getCandidate
ModuleComponentIdentifier getCandidate()
Gets the candidate version of the module.- Returns:
- the candidate version of the module
-
getMetadata
@Nullable ComponentMetadata getMetadata()
Gets the metadata of the component.The metadata may not be available, in which case
nullis returned. Unavailable metadata may be caused by a module published without associated metadata.- Returns:
- the
ComponentMetadataornullif not available - Since:
- 5.0
-
getDescriptor
@Nullable <T> T getDescriptor(java.lang.Class<T> descriptorClass)
Used to access a specific descriptor format.For an Ivy module, an
ivy module descriptorcan be requested and returned.If the descriptor type requested does not exist for the module under selection,
nullis returned.- Type Parameters:
T- the descriptor type- Parameters:
descriptorClass- the descriptor class- Returns:
- a descriptor fo the requested type, or
nullif there was none of the requested type. - Since:
- 5.0
- See Also:
IvyModuleDescriptor
-
reject
void reject(java.lang.String reason)
Rejects the candidate for the resolution.- Parameters:
reason- The reason the candidate was rejected.
-
-