Package org.gradle.api.artifacts.result
Interface ComponentSelectionReason
-
public interface ComponentSelectionReasonAnswers the question why a component was selected during the dependency resolution.- Since:
- 1.3
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description StringgetDescription()Deprecated.UsegetDescriptions()insteadList<ComponentSelectionDescriptor>getDescriptions()Returns a list of descriptions of the causes that led to the selection of this component.booleanisCompositeSubstitution()Informs whether the selected component is a project substitute from a build participating in in a composite build.booleanisConflictResolution()Informs whether the component was selected by conflict resolution.booleanisConstrained()Informs whether the selected component version has been influenced by a dependency constraint.booleanisExpected()Informs whether the component is the requested selection of all dependency declarations, and was not replaced for some reason, such as conflict resolution.booleanisForced()Informs whether the component was forced.booleanisSelectedByRule()Informs whether the component was selected by the dependency substitution rule.
-
-
-
Method Detail
-
isForced
boolean isForced()
Informs whether the component was forced. Users can force components viaResolutionStrategyor when declaring dependencies (seeDependencyHandler).
-
isConflictResolution
boolean isConflictResolution()
Informs whether the component was selected by conflict resolution. For more information about Gradle's conflict resolution please refer to the user guide.ResolutionStrategycontains information about conflict resolution and includes means to configure it.
-
isSelectedByRule
boolean isSelectedByRule()
Informs whether the component was selected by the dependency substitution rule. Users can configure dependency substitution rules viaResolutionStrategy.getDependencySubstitution()- Since:
- 1.4
-
isExpected
boolean isExpected()
Informs whether the component is the requested selection of all dependency declarations, and was not replaced for some reason, such as conflict resolution.- Since:
- 1.11
-
isCompositeSubstitution
@Incubating boolean isCompositeSubstitution()
Informs whether the selected component is a project substitute from a build participating in in a composite build.- Since:
- 4.5
-
isConstrained
boolean isConstrained()
Informs whether the selected component version has been influenced by a dependency constraint.- Returns:
- true if a dependency constraint influenced the selection of this component
- Since:
- 4.6
-
getDescription
@Deprecated String getDescription()
Deprecated.UsegetDescriptions()insteadReturns a human-consumable description of this selection reason.
-
getDescriptions
@Incubating List<ComponentSelectionDescriptor> getDescriptions()
Returns a list of descriptions of the causes that led to the selection of this component.- Returns:
- the list of descriptions.
- Since:
- 4.6
-
-