Interface RepositoryHandler
- All Superinterfaces:
- ArtifactRepositoryContainer,- Collection<ArtifactRepository>,- Configurable<ArtifactRepositoryContainer>,- DomainObjectCollection<ArtifactRepository>,- Iterable<ArtifactRepository>,- List<ArtifactRepository>,- NamedDomainObjectCollection<ArtifactRepository>,- NamedDomainObjectList<ArtifactRepository>,- SequencedCollection<ArtifactRepository>
RepositoryHandler manages a set of repositories, allowing repositories to be defined and queried.- 
Field SummaryFields inherited from interface org.gradle.api.artifacts.ArtifactRepositoryContainerDEFAULT_MAVEN_CENTRAL_REPO_NAME, DEFAULT_MAVEN_LOCAL_REPO_NAME, GOOGLE_URL, MAVEN_CENTRAL_URL
- 
Method SummaryModifier and TypeMethodDescriptionvoidexclusiveContent(Action<? super ExclusiveContentRepository> action) Declares exclusive content repositories.Adds and configures a repository which will look for dependencies in a number of local directories.Adds a resolver that looks into a number of directories for artifacts.flatDir(Action<? super FlatDirectoryArtifactRepository> action) Adds and configures a repository which will look for dependencies in a number of local directories.google()Adds a repository which looks in Google's Maven repository for dependencies.google(Action<? super MavenArtifactRepository> action) Adds a repository which looks in Google's Maven repository for dependencies.Adds a repository which looks in Gradle Central Plugin Repository for dependencies.gradlePluginPortal(Action<? super ArtifactRepository> action) Adds a repository which looks in Gradle Central Plugin Repository for dependencies.Adds and configures an Ivy repository.ivy(Action<? super IvyArtifactRepository> action) Adds and configures an Ivy repository.jcenter()Deprecated.JFrog announced JCenter's sunset in February 2021.jcenter(Action<? super MavenArtifactRepository> action) Deprecated.JFrog announced JCenter's sunset in February 2021.Adds and configures a Maven repository.maven(Action<? super MavenArtifactRepository> action) Adds and configures a Maven repository.Adds a repository which looks in the Maven central repository for dependencies.mavenCentral(Map<String, ?> args) Adds a repository which looks in the Maven central repository for dependencies.mavenCentral(Action<? super MavenArtifactRepository> action) Adds a repository which looks in the Maven central repository for dependencies.Adds a repository which looks in the local Maven cache for dependencies.mavenLocal(Action<? super MavenArtifactRepository> action) Adds a repository which looks in the local Maven cache for dependencies.Methods inherited from interface org.gradle.api.artifacts.ArtifactRepositoryContaineradd, addFirst, addLast, getAt, getByName, getByName, getByNameMethods inherited from interface java.util.CollectionparallelStream, removeIf, stream, toArrayMethods inherited from interface org.gradle.util.ConfigurableconfigureMethods inherited from interface org.gradle.api.DomainObjectCollectionaddAllLater, addLater, all, all, configureEach, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withTypeMethods inherited from interface java.util.Listadd, addAll, addAll, clear, contains, containsAll, equals, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, set, size, sort, spliterator, subList, toArray, toArrayMethods inherited from interface org.gradle.api.NamedDomainObjectCollectionaddAll, addRule, addRule, addRule, findByName, getAsMap, getCollectionSchema, getNamer, getNames, getRules, named, named, named, named
- 
Method Details- 
flatDirAdds a resolver that looks into a number of directories for artifacts. The artifacts are expected to be located in the root of the specified directories. The resolver ignores any group/organization information specified in the dependency section of your build script. If you only use this kind of resolver you might specify your dependencies like":junit:4.4"instead of"junit:junit:4.4". The following parameter are accepted as keys for the map:Shows property keys and associated values Key Description of Associated Value name(optional) The name of the repository. The default is a Hash value of the rootdir paths. The name is used in the console output, to point to information related to a particular repository. A name must be unique amongst a repository group. dirsSpecifies a list of rootDirs where to look for dependencies. These are evaluated as per Project.files(Object...)Examples: repositories { flatDir name: 'libs', dirs: "$projectDir/libs" flatDir dirs: ["$projectDir/libs1", "$projectDir/libs2"] }- Parameters:
- args- The arguments used to configure the repository.
- Returns:
- the added resolver
- Throws:
- InvalidUserDataException- In the case neither rootDir nor rootDirs is specified of if both are specified.
 
- 
flatDirFlatDirectoryArtifactRepository flatDir(@DelegatesTo(FlatDirectoryArtifactRepository.class) Closure configureClosure) Adds and configures a repository which will look for dependencies in a number of local directories.- Parameters:
- configureClosure- The closure to execute to configure the repository.
- Returns:
- The repository.
 
- 
flatDirAdds and configures a repository which will look for dependencies in a number of local directories.- Parameters:
- action- The action to execute to configure the repository.
- Returns:
- The repository.
 
- 
gradlePluginPortalArtifactRepository gradlePluginPortal()Adds a repository which looks in Gradle Central Plugin Repository for dependencies.- Returns:
- The Gradle Central Plugin Repository
- Since:
- 4.4
 
- 
gradlePluginPortalAdds a repository which looks in Gradle Central Plugin Repository for dependencies.- Parameters:
- action- a configuration action
- Returns:
- the added resolver
- Since:
- 5.4
 
- 
jcenterDeprecated.JFrog announced JCenter's sunset in February 2021. UsemavenCentral()instead.Adds a repository which looks in Bintray's JCenter repository for dependencies.The URL used to access this repository is "https://jcenter.bintray.com/". The behavior of this repository is otherwise the same as those added by maven(org.gradle.api.Action).Examples: repositories { jcenter { artifactUrls = ["http://www.mycompany.com/artifacts1", "http://www.mycompany.com/artifacts2"] } jcenter { name = "nonDefaultName" artifactUrls = ["http://www.mycompany.com/artifacts1"] } }- Parameters:
- action- a configuration action
- Returns:
- the added repository
 
- 
jcenterDeprecated.JFrog announced JCenter's sunset in February 2021. UsemavenCentral()instead.Adds a repository which looks in Bintray's JCenter repository for dependencies.The URL used to access this repository is "https://jcenter.bintray.com/". The behavior of this repository is otherwise the same as those added by maven(org.gradle.api.Action).Examples: repositories { jcenter() }- Returns:
- the added resolver
- See Also:
 
- 
mavenCentralAdds a repository which looks in the Maven central repository for dependencies. The URL used to access this repository is "https://repo.maven.apache.org/maven2/".The following parameter are accepted as keys for the map: Shows property keys and associated values Key Description of Associated Value name(optional) The name of the repository. The default is "MavenRepo" is used as the name. A name must be unique amongst a repository group. artifactUrlsA single jar repository or a collection of jar repositories containing additional artifacts not found in the Maven central repository. But be aware that the POM must exist in Maven central. The provided values are evaluated as per Project.uri(Object).Examples: repositories { mavenCentral artifactUrls: ["http://www.mycompany.com/artifacts1", "http://www.mycompany.com/artifacts2"] mavenCentral name: "nonDefaultName", artifactUrls: ["http://www.mycompany.com/artifacts1"] }- Parameters:
- args- A list of urls of repositories to look for artifacts only.
- Returns:
- the added repository
 
- 
mavenCentralMavenArtifactRepository mavenCentral()Adds a repository which looks in the Maven central repository for dependencies. The URL used to access this repository is "https://repo.maven.apache.org/maven2/". The name of the repository is "MavenRepo".Examples: repositories { mavenCentral() }- Returns:
- the added resolver
- See Also:
 
- 
mavenCentralAdds a repository which looks in the Maven central repository for dependencies. The URL used to access this repository is "https://repo.maven.apache.org/maven2/". The name of the repository is "MavenRepo".Examples: repositories { mavenCentral() }- Parameters:
- action- a configuration action
- Returns:
- the added resolver
- Since:
- 5.3
 
- 
mavenLocalMavenArtifactRepository mavenLocal()Adds a repository which looks in the local Maven cache for dependencies. The name of the repository is "MavenLocal".Examples: repositories { mavenLocal() }The location for the repository is determined as follows (in order of precedence): - The value of system property 'maven.repo.local' if set;
- The value of element <localRepository> of ~/.m2/settings.xmlif this file exists and element is set;
- The value of element <localRepository> of $M2_HOME/conf/settings.xml(where$M2_HOMEis the value of the environment variable with that name) if this file exists and element is set;
- The path ~/.m2/repository.
 - Returns:
- the added resolver
 
- 
mavenLocalAdds a repository which looks in the local Maven cache for dependencies. The name of the repository is "MavenLocal".Examples: repositories { mavenLocal() }The location for the repository is determined as follows (in order of precedence): - The value of system property 'maven.repo.local' if set;
- The value of element <localRepository> of ~/.m2/settings.xmlif this file exists and element is set;
- The value of element <localRepository> of $M2_HOME/conf/settings.xml(where$M2_HOMEis the value of the environment variable with that name) if this file exists and element is set;
- The path ~/.m2/repository.
 - Parameters:
- action- a configuration action
- Returns:
- the added resolver
- Since:
- 5.3
 
- 
googleMavenArtifactRepository google()Adds a repository which looks in Google's Maven repository for dependencies.The URL used to access this repository is "https://dl.google.com/dl/android/maven2/". Examples: repositories { google() }- Returns:
- the added resolver
- Since:
- 4.0
 
- 
googleAdds a repository which looks in Google's Maven repository for dependencies.The URL used to access this repository is "https://dl.google.com/dl/android/maven2/". Examples: repositories { google() }- Parameters:
- action- a configuration action
- Returns:
- the added resolver
- Since:
- 5.3
 
- 
mavenAdds and configures a Maven repository. Newly created instance ofMavenArtifactRepositoryis passed as an argument to the closure.- Parameters:
- closure- The closure to use to configure the repository.
- Returns:
- The added repository.
 
- 
mavenAdds and configures a Maven repository.- Parameters:
- action- The action to use to configure the repository.
- Returns:
- The added repository.
 
- 
ivyAdds and configures an Ivy repository. Newly created instance ofIvyArtifactRepositoryis passed as an argument to the closure.- Parameters:
- closure- The closure to use to configure the repository.
- Returns:
- The added repository.
 
- 
ivyAdds and configures an Ivy repository.- Parameters:
- action- The action to use to configure the repository.
- Returns:
- The added repository.
 
- 
exclusiveContentDeclares exclusive content repositories. Exclusive content repositories are repositories for which you can declare an inclusive content filter. Artifacts matching the filter will then only be searched in the repositories which exclusively match it.- Parameters:
- action- the configuration of the repositories
- Since:
- 6.2
 
 
-