ComponentSelectionRules

API Documentation:ComponentSelectionRules

Note: This class is incubating and may change in a future version of Gradle.

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.name == 'someModule' && selection.candidate.version == '1.1') {
                            selection.reject("bad version '1.1' for 'someModule'")
                        }
                    }
                    all { ComponentSelection selection, IvyModuleDescriptor descriptor, ComponentMetadata metadata ->
                        if (selection.candidate.name == 'someModule' && descriptor.branch == 'testing') {
                            if (metadata.status != 'milestone') {
                                selection.reject("only use milestones for someModule:testing")
                            }
                        }
                    }
                    module("org.sample:api") { ComponentSelection selection ->
                        if (selection.candidate.version == "1.1") {
                            selection.reject("known bad version")
                        }
                    }
                }
            }
        }
    }

Properties

No properties

Methods

MethodDescription
all(closure)
Incubating

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), ComponentMetadata and/or IvyModuleDescriptor.

all(selectionAction)
Incubating

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

module(id, closure)
Incubating

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), ComponentMetadata and/or IvyModuleDescriptor.

module(id, selectionAction)
Incubating

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

Script blocks

No script blocks

Method details

Note: This method is incubating and may change in a future version of Gradle.

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), ComponentMetadata and/or IvyModuleDescriptor.

ComponentSelectionRules all(Action<? super ComponentSelection> selectionAction)

Note: This method is incubating and may change in a future version of Gradle.

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

ComponentSelectionRules module(Object id, Closure<?> closure)

Note: This method is incubating and may change in a future version of Gradle.

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), ComponentMetadata and/or IvyModuleDescriptor.

ComponentSelectionRules module(Object id, Action<? super ComponentSelection> selectionAction)

Note: This method is incubating and may change in a future version of Gradle.

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