Package org.gradle.api.artifacts.repositories

Interface InclusiveRepositoryContentDescriptor

All Known Subinterfaces:
MavenRepositoryContentDescriptor, RepositoryContentDescriptor
public interface InclusiveRepositoryContentDescriptor

Descriptor of a repository content, used to avoid reaching to an external repository when not needed.

Only inclusions can be defined at this level (cross-repository content). Excludes need to be defined per-repository using RepositoryContentDescriptor. Similarly to declaring includes on specific repositories via ArtifactRepository.content(Action), inclusions are extensive, meaning that anything which doesn't match the includes will be considered missing from the repository.

Since:
6.2

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    includeGroup(String group)
    Declares that an entire group should be searched for in this repository.
    void
    includeGroupAndSubgroups(String groupPrefix)
    Declares that an entire group and its subgroups should be searched for in this repository.
    void
    includeGroupByRegex(String groupRegex)
    Declares that an entire group should be searched for in this repository.
    void
    includeModule(String group, String moduleName)
    Declares that an entire module should be searched for in this repository.
    void
    includeModuleByRegex(String groupRegex, String moduleNameRegex)
    Declares that an entire module should be searched for in this repository, using regular expressions.
    void
    includeVersion(String group, String moduleName, String version)
    Declares that a specific module version should be searched for in this repository.
    void
    includeVersionByRegex(String groupRegex, String moduleNameRegex, String versionRegex)
    Declares that a specific module version should be searched for in this repository, using regular expressions.

  • Method Details

    • includeGroup

      void includeGroup(String group)
      Declares that an entire group should be searched for in this repository.
      Parameters:
      group - the group name

    • includeGroupAndSubgroups

      @Incubating void includeGroupAndSubgroups(String groupPrefix)
      Declares that an entire group and its subgroups should 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, then org.gradle is matched as a group, and org.gradle.foo and org.gradle.foo.bar are matched as subgroups. org.gradlefoo is not matched as a subgroup.

      Parameters:
      groupPrefix - the group prefix to include
      Since:
      8.1

    • includeGroupByRegex

      void includeGroupByRegex(String groupRegex)
      Declares that an entire group should be searched for in this repository.
      Parameters:
      groupRegex - a regular expression of the group name

    • includeModule

      void includeModule(String group, String moduleName)
      Declares that an entire module should be searched for in this repository.
      Parameters:
      group - the group name
      moduleName - the module name

    • includeModuleByRegex

      void includeModuleByRegex(String groupRegex, String moduleNameRegex)
      Declares that an entire module should be searched for in this repository, using regular expressions.
      Parameters:
      groupRegex - the group name regular expression
      moduleNameRegex - the module name regular expression

    • includeVersion

      void includeVersion(String group, String moduleName, String version)
      Declares that a specific module version should be searched for in this repository.
      Parameters:
      group - the group name
      moduleName - the module name
      version - the module version

    • includeVersionByRegex

      void includeVersionByRegex(String groupRegex, String moduleNameRegex, String versionRegex)
      Declares that a specific module version should be searched for in this repository, using regular expressions.
      Parameters:
      groupRegex - the group name regular expression
      moduleNameRegex - the module name regular expression
      versionRegex - the module version regular expression