api / org.gradle.api.artifacts / ComponentSelectionRules

ComponentSelectionRules

@Incubating interface ComponentSelectionRules

* Represents a container for component selection rules. Rules can be applied as part of the resolutionStrategy of a configuration and individual components can be explicitly accepted or rejected by rule. Components that are neither accepted or rejected will be subject to the default version matching strategies.

 configurations { conf { resolutionStrategy { componentSelection { all { ComponentSelection selection -> if (selection.candidate.module == 'someModule' && selection.candidate.version == '1.1') { selection.reject("bad version '1.1' for 'someModule'") } } all { ComponentSelection selection, IvyModuleDescriptor descriptor, ComponentMetadata metadata -> if (selection.candidate.module == 'someModule' && descriptor.branch == 'testing') { if (metadata.status != 'milestone') { selection.reject("only use milestones for someModule:testing") } } } withModule("org.sample:api") { ComponentSelection selection -> if (selection.candidate.version == "1.1") { selection.reject("known bad version") } } } } } } 

Functions

all

abstract fun all(selectionAction: Action<in ComponentSelection>): ComponentSelectionRules

Adds a simple component selection rule that will apply to all resolved components. Each rule will receive a ComponentSelection object as an argument.

abstract fun all(closure: Closure<*>): ComponentSelectionRules

Adds a component selection rule that will apply to all resolved components. Each rule will receive a ComponentSelection object as an argument as well as any other arguments specified for the closure. Allowable closure arguments are ComponentSelection (required), org.gradle.api.artifacts.ComponentMetadata and/or org.gradle.api.artifacts.ivy.IvyModuleDescriptor.

abstract fun all(ruleSource: Any): ComponentSelectionRules

Adds a rule-source backed component selection rule that will apply to all resolved components. The ruleSource provides the rule as exactly one rule method annotated with org.gradle.model.Mutate. This rule method:

  • must return void.
  • must have org.gradle.api.artifacts.ComponentSelection as the first parameter.
  • may have additional parameters of type org.gradle.api.artifacts.ComponentMetadata and/or org.gradle.api.artifacts.ivy.IvyModuleDescriptor.

withModule

abstract fun withModule(id: Any, selectionAction: Action<in ComponentSelection>): ComponentSelectionRules

Adds a component selection rule that will apply to the specified module. Each rule will receive a ComponentSelection object as an argument.

abstract fun withModule(id: Any, closure: Closure<*>): ComponentSelectionRules

Adds a component selection rule that will apply to the specified module. Each rule will receive a ComponentSelection object as an argument as well as any other arguments specified for the closure. Allowable closure arguments are ComponentSelection (required), org.gradle.api.artifacts.ComponentMetadata and/or org.gradle.api.artifacts.ivy.IvyModuleDescriptor.

abstract fun withModule(id: Any, ruleSource: Any): ComponentSelectionRules

Adds a rule-source backed component selection rule that will apply to the specified module. The ruleSource provides the rule as exactly one rule method annotated with org.gradle.model.Mutate. This rule method:

  • must return void.
  • must have org.gradle.api.artifacts.ComponentSelection as the first parameter.
  • may have additional parameters of type org.gradle.api.artifacts.ComponentMetadata and/or org.gradle.api.artifacts.ivy.IvyModuleDescriptor.