Interface RepositoryContentDescriptor
- All Superinterfaces:
InclusiveRepositoryContentDescriptor
- All Known Subinterfaces:
MavenRepositoryContentDescriptor
Descriptor of a repository content, used to avoid reaching to an external repository when not needed.
Excludes are applied after includes. This means that by default, everything is included and nothing excluded. If includes are added, then if the module doesn't match any of the includes, it's excluded. Then if it does, but it also matches one of the excludes, it's also excluded.
- Since:
- 5.1
-
Method Summary
Modifier and TypeMethodDescriptionvoidexcludeGroup(String group) Declares that an entire group shouldn't be searched for in this repository.voidexcludeGroupAndSubgroups(String groupPrefix) Declares that an entire group and its subgroups shouldn't be searched for in this repository.voidexcludeGroupByRegex(String groupRegex) Declares that an entire group shouldn't be searched for in this repository.voidexcludeModule(String group, String moduleName) Declares that an entire module shouldn't be searched for in this repository.voidexcludeModuleByRegex(String groupRegex, String moduleNameRegex) Declares that an entire module shouldn't be searched for in this repository, using regular expressions.voidexcludeVersion(String group, String moduleName, String version) Declares that a specific module version shouldn't be searched for in this repository.voidexcludeVersionByRegex(String groupRegex, String moduleNameRegex, String versionRegex) Declares that a specific module version shouldn't be searched for in this repository, using regular expressions.voidnotForConfigurations(String... configurationNames) Declares that this repository should not be used for a specific set of configurations.<T> voidonlyForAttribute(Attribute<T> attribute, T... validValues) Declares that this repository will only be searched if the consumer requires a specific attribute.voidonlyForConfigurations(String... configurationNames) Declares that this repository should only be used for a specific set of configurations.Methods inherited from interface org.gradle.api.artifacts.repositories.InclusiveRepositoryContentDescriptor
includeGroup, includeGroupAndSubgroups, includeGroupByRegex, includeModule, includeModuleByRegex, includeVersion, includeVersionByRegex
-
Method Details
-
excludeGroup
Declares that an entire group shouldn't be searched for in this repository.- Parameters:
group- the group name
-
excludeGroupAndSubgroups
Declares that an entire group and its subgroups shouldn't be searched for in this repository.A subgroup is a group that starts with the given prefix and has a dot immediately after the prefix. For example, if the prefix is
org.gradle, thenorg.gradleis matched as a group, andorg.gradle.fooandorg.gradle.foo.barare matched as subgroups.org.gradlefoois not matched as a subgroup.- Parameters:
groupPrefix- the group prefix to include- Since:
- 8.1
-
excludeGroupByRegex
Declares that an entire group shouldn't be searched for in this repository.- Parameters:
groupRegex- the group name regular expression
-
excludeModule
Declares that an entire module shouldn't be searched for in this repository.- Parameters:
group- the group namemoduleName- the module name
-
excludeModuleByRegex
Declares that an entire module shouldn't be searched for in this repository, using regular expressions.- Parameters:
groupRegex- the group name regular expressionmoduleNameRegex- the module name regular expression
-
excludeVersion
Declares that a specific module version shouldn't be searched for in this repository.The version notation for a regex will be matched against a single version and does not support range notations.
- Parameters:
group- the group namemoduleName- the module nameversion- the module version
-
excludeVersionByRegex
Declares that a specific module version shouldn't be searched for in this repository, using regular expressions.The version notation for a regex will be matched against a single version and does not support range notations.
- Parameters:
groupRegex- the group namemoduleNameRegex- the module nameversionRegex- the module version
-
onlyForConfigurations
Declares that this repository should only be used for a specific set of configurations. Defaults to any configuration- Parameters:
configurationNames- the names of the configurations the repository will be used for
-
notForConfigurations
Declares that this repository should not be used for a specific set of configurations. Defaults to any configuration- Parameters:
configurationNames- the names of the configurations the repository will not be used for
-
onlyForAttribute
Declares that this repository will only be searched if the consumer requires a specific attribute.- Type Parameters:
T- the type of the attribute- Parameters:
attribute- the attributevalidValues- the list of accepted values
-