Table of Contents
| API Documentation: | ComponentSelectionRules |
|---|
Represents a container for component selection rules. Rules can be applied as part of theresolutionStrategy of a configuration and individual components can be explicitly acceptedor rejected by rule. Components that are neither accepted or rejected will be subject tothe 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 ->if (selection.candidate.module =='someModule' && selection.getDescriptor(IvyModuleDescriptor)?.branch =='testing') {if (selection.metadata == null || selection.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") } } } } }}| Method | Description |
all(closure) | Adds a component selection rule that will apply to all resolved components.Each rule will receive a |
all(ruleSource) | 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 |
all(selectionAction) | Adds a simple component selection rule that will apply to all resolved components.Each rule will receive a |
withModule(id, closure) | Adds a component selection rule that will apply to the specified module.Each rule will receive a |
withModule(id, ruleSource) | 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 |
withModule(id, selectionAction) | Adds a component selection rule that will apply to the specified module.Each rule will receive a |
ComponentSelectionRulesall(Closure<?>
Closure<?>Adds a component selection rule that will apply to all resolved components.Each rule will receive aComponentSelection object as an argument.
ComponentSelectionRulesall(Object ruleSource)
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 withMutate.This rule method:
- must return void.
- must have
ComponentSelectionas its parameter.
ComponentSelectionRulesall(Action<? superComponentSelection>
Action<? superComponentSelection>Adds a simple component selection rule that will apply to all resolved components.Each rule will receive aComponentSelection object as an argument.
ComponentSelectionRuleswithModule(Object id,Closure<?>
Closure<?>Adds a component selection rule that will apply to the specified module.Each rule will receive aComponentSelection object as an argument.
ComponentSelectionRuleswithModule(Object id,Object ruleSource)
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 withMutate.This rule method:
- must return void.
- must have
ComponentSelectionas its parameter.
ComponentSelectionRuleswithModule(Object id,Action<? superComponentSelection>
Action<? superComponentSelection>Adds a component selection rule that will apply to the specified module.Each rule will receive aComponentSelection object as an argument.