# RepositoryHandler

@ServiceScope(value = Project::class)
interface RepositoryHandler : ArtifactRepositoryContainer(source)

A `RepositoryHandler` manages a set of repositories, allowing repositories to be defined and queried.

## Properties

DEFAULT_MAVEN_CENTRAL_REPO_NAME
Link copied to clipboard
val DEFAULT_MAVEN_CENTRAL_REPO_NAME: String = "MavenRepo"
DEFAULT_MAVEN_LOCAL_REPO_NAME
Link copied to clipboard
val DEFAULT_MAVEN_LOCAL_REPO_NAME: String = "MavenLocal"
GOOGLE_URL
Link copied to clipboard
val GOOGLE_URL: String = "https://dl.google.com/dl/android/maven2/"
MAVEN_CENTRAL_URL
Link copied to clipboard
val MAVEN_CENTRAL_URL: String = "https://repo.maven.apache.org/maven2/"

## Functions

add
Link copied to clipboard
abstract fun add(p: E): Boolean
abstract fun add(p: Int, p1: E)
abstract fun add(e: T): Boolean
Adds an object to the collection, if there is no existing object in the collection with the same name.
abstract fun add(repository: ArtifactRepository): Boolean
Adds a repository to this container, at the end of the repository sequence.
addAll
Link copied to clipboard
abstract fun addAll(p: Collection<out E>): Boolean
abstract fun addAll(c: Collection<out T>): Boolean
Adds any of the given objects to the collection that do not have the same name as any existing element.
addAllLater
Link copied to clipboard
abstract fun addAllLater(provider: Provider<out Iterable<T>>)
Adds elements to this collection, given a Provider of Iterable that will provide the elements when required.
addFirst
Link copied to clipboard
abstract fun addFirst(repository: ArtifactRepository)
Adds a repository to this container, at the start of the repository sequence.
addLast
Link copied to clipboard
abstract fun addLast(repository: ArtifactRepository)
Adds a repository to this container, at the end of the repository sequence.
addLater
Link copied to clipboard
abstract fun addLater(provider: Provider<out T>)
Adds an element to this collection, given a Provider that will provide the element when required.
addRule
Link copied to clipboard
abstract fun addRule(rule: Rule): Rule
abstract fun addRule(description: String, ruleAction: Closure): Rule
abstract fun addRule(description: String, ruleAction: Action<String>): Rule
Adds a rule to this collection.
all
Link copied to clipboard
abstract fun all(action: Closure)
Executes the given closure against all objects in this collection, and any objects subsequently added to this collection.
abstract fun all(action: Action<in T>)
Executes the given action against all objects in this collection, and any objects subsequently added to this collection.
clear
Link copied to clipboard
abstract fun clear()
configure
Link copied to clipboard
abstract fun configure(cl: Closure): T
configureEach
Link copied to clipboard
abstract fun configureEach(action: Action<in T>)
Configures each element in this collection using the given action, as each element is required.
contains
Link copied to clipboard
abstract fun contains(p: Any): Boolean
containsAll
Link copied to clipboard
abstract fun containsAll(p: Collection<out Any>): Boolean
copyOf
Link copied to clipboard
open fun <E> copyOf(coll: Collection<out E>): List<E>
disallowChanges
Link copied to clipboard
@Incubating
open fun disallowChanges()
Disallows further structural modifications to this collection.
equals
Link copied to clipboard
abstract fun equals(p: Any): Boolean
exclusiveContent
Link copied to clipboard
abstract fun exclusiveContent(action: Action<in ExclusiveContentRepository>)
Declares exclusive content repositories.
findAll
Link copied to clipboard
abstract fun findAll(spec: Closure): Collection<T>
abstract fun findAll(spec: Closure): List<T>
Returns a collection which contains the objects in this collection which meet the given closure specification.
findByName
Link copied to clipboard
@Nullable
abstract fun findByName(name: String): @Nullable T
Locates an object by name, returning null if there is no such object.
flatDir
Link copied to clipboard
abstract fun flatDir(@DelegatesTo(value = FlatDirectoryArtifactRepository::class) configureClosure: Closure): FlatDirectoryArtifactRepository
abstract fun flatDir(action: Action<in FlatDirectoryArtifactRepository>): FlatDirectoryArtifactRepository
Adds and configures a repository which will look for dependencies in a number of local directories.
abstract fun flatDir(args: Map<String, out Any>): FlatDirectoryArtifactRepository
Adds a resolver that looks into a number of directories for artifacts.
forEach
Link copied to clipboard
open fun forEach(action: Consumer<in T>)
get
Link copied to clipboard
abstract fun get(p: Int): E
getAsMap
Link copied to clipboard
abstract fun getAsMap(): SortedMap<String, T>
Returns the objects in this collection, as a map from object name to object instance.
getAt
Link copied to clipboard
abstract fun getAt(name: String): T
abstract fun getAt(name: String): ArtifactRepository
Locates an object by name, failing if there is no such object.
getByName
Link copied to clipboard
abstract fun getByName(name: String): T
abstract fun getByName(name: String, configureClosure: Closure): T
abstract fun getByName(name: String, configureAction: Action<in T>): T
abstract fun getByName(name: String): ArtifactRepository
abstract fun getByName(name: String, @DelegatesTo(value = ArtifactRepository::class) configureClosure: Closure): ArtifactRepository
abstract fun getByName(name: String, configureAction: Action<in ArtifactRepository>): ArtifactRepository
Locates an object by name, failing if there is no such object.
getCollectionSchema
Link copied to clipboard
@Internal
abstract fun getCollectionSchema(): NamedDomainObjectCollectionSchema
Provides access to the schema of all created or registered named domain objects in this collection.
getNamer
Link copied to clipboard
abstract fun getNamer(): Namer<T>
An object that represents the naming strategy used to name objects of this collection.
getNames
Link copied to clipboard
abstract fun getNames(): SortedSet<String>
Returns the names of the objects in this collection as a Set of Strings.
getRules
Link copied to clipboard
abstract fun getRules(): List<Rule>
Returns the rules used by this collection.
google
Link copied to clipboard
abstract fun google(): MavenArtifactRepository
abstract fun google(action: Action<in MavenArtifactRepository>): MavenArtifactRepository
Adds a repository which looks in Google's Maven repository for dependencies.
gradlePluginPortal
Link copied to clipboard
abstract fun gradlePluginPortal(): ArtifactRepository
abstract fun gradlePluginPortal(action: Action<in ArtifactRepository>): ArtifactRepository
Adds a repository which looks in Gradle Central Plugin Repository for dependencies.
hashCode
Link copied to clipboard
abstract fun hashCode(): Int
indexOf
Link copied to clipboard
abstract fun indexOf(p: Any): Int
isEmpty
Link copied to clipboard
abstract fun isEmpty(): Boolean
iterator
Link copied to clipboard
abstract fun iterator(): Iterator<T>
abstract fun iterator(): Iterator<E>
ivy
Link copied to clipboard
abstract fun ivy(@DelegatesTo(value = IvyArtifactRepository::class) closure: Closure): IvyArtifactRepository
abstract fun ivy(action: Action<in IvyArtifactRepository>): IvyArtifactRepository
Adds and configures an Ivy repository.
lastIndexOf
Link copied to clipboard
abstract fun lastIndexOf(p: Any): Int
listIterator
Link copied to clipboard
abstract fun listIterator(): ListIterator<E>
matching
Link copied to clipboard
abstract fun matching(spec: Closure): DomainObjectCollection<T>
abstract fun matching(spec: Closure): NamedDomainObjectCollection<T>
Returns a collection which contains the objects in this collection which meet the given closure specification.
abstract fun matching(spec: Spec<in T>): DomainObjectCollection<T>
abstract fun matching(spec: Spec<in T>): NamedDomainObjectCollection<T>
Returns a collection which contains the objects in this collection which meet the given specification.
abstract fun matching(spec: Closure): NamedDomainObjectList<T>
abstract fun matching(spec: Spec<in T>): NamedDomainObjectList<T>
maven
Link copied to clipboard
abstract fun maven(@DelegatesTo(value = MavenArtifactRepository::class) closure: Closure): MavenArtifactRepository
abstract fun maven(action: Action<in MavenArtifactRepository>): MavenArtifactRepository
Adds and configures a Maven repository.
mavenCentral
Link copied to clipboard
abstract fun mavenCentral(): MavenArtifactRepository
abstract fun mavenCentral(args: Map<String, out Any>): MavenArtifactRepository
abstract fun mavenCentral(action: Action<in MavenArtifactRepository>): MavenArtifactRepository
Adds a repository which looks in the Maven central repository for dependencies.
mavenLocal
Link copied to clipboard
abstract fun mavenLocal(): MavenArtifactRepository
abstract fun mavenLocal(action: Action<in MavenArtifactRepository>): MavenArtifactRepository
Adds a repository which looks in the local Maven cache for dependencies.
named
Link copied to clipboard
abstract fun named(name: String): NamedDomainObjectProvider<T>
abstract fun named(name: String, configurationAction: Action<in T>): NamedDomainObjectProvider<T>
Locates a object by name, failing if there is no such object.
@Incubating
open fun named(nameFilter: Spec<String>): NamedDomainObjectCollection<T>
abstract fun named(nameFilter: Spec<String>): NamedDomainObjectList<T>
Returns a collection containing the objects with names matching the provided filter.
abstract fun <S : T?> named(name: String, type: Class<S>): NamedDomainObjectProvider<S>
abstract fun <S : T?> named(name: String, type: Class<S>, configurationAction: Action<in S>): NamedDomainObjectProvider<S>
Locates a object by name and type, failing if there is no such object.
of
Link copied to clipboard
open fun <E> of(): List<E>
parallelStream
Link copied to clipboard
open fun parallelStream(): Stream<E>
remove
Link copied to clipboard
abstract fun remove(p: Int): E
abstract fun remove(p: Any): Boolean
removeAll
Link copied to clipboard
abstract fun removeAll(p: Collection<out Any>): Boolean
removeIf
Link copied to clipboard
open fun removeIf(filter: Predicate<in E>): Boolean
replaceAll
Link copied to clipboard
open fun replaceAll(operator: UnaryOperator<E>)
retainAll
Link copied to clipboard
abstract fun retainAll(p: Collection<out Any>): Boolean
set
Link copied to clipboard
abstract fun set(p: Int, p1: E): E
size
Link copied to clipboard
abstract fun size(): Int
sort
Link copied to clipboard
open fun sort(c: Comparator<in E>)
spliterator
Link copied to clipboard
open fun spliterator(): Spliterator<T>
open fun spliterator(): Spliterator<E>
stream
Link copied to clipboard
open fun stream(): Stream<E>
subList
Link copied to clipboard
abstract fun subList(p: Int, p1: Int): List<E>
toArray
Link copied to clipboard
abstract fun toArray(): Array<Any>
abstract fun <T> toArray(p: Array<T>): Array<T>
whenObjectAdded
Link copied to clipboard
abstract fun whenObjectAdded(action: Closure)
Adds a closure to be called when an object is added to this collection.
abstract fun whenObjectAdded(action: Action<in T>): Action<in T>
Adds an `Action` to be executed when an object is added to this collection.
whenObjectRemoved
Link copied to clipboard
abstract fun whenObjectRemoved(action: Closure)
Adds a closure to be called when an object is removed from this collection.
abstract fun whenObjectRemoved(action: Action<in T>): Action<in T>
Adds an `Action` to be executed when an object is removed from this collection.
withType
Link copied to clipboard
abstract fun <S : T?> withType(type: Class<S>): DomainObjectCollection<S>
abstract fun <S : T?> withType(type: Class<S>, @DelegatesTo(genericTypeIndex = 0) configureClosure: Closure): DomainObjectCollection<S>
abstract fun <S : T?> withType(type: Class<S>, configureAction: Action<in S>): DomainObjectCollection<S>
abstract fun <S : T?> withType(type: Class<S>): NamedDomainObjectCollection<S>
Returns a collection containing the objects in this collection of the given type.
abstract fun <S : T?> withType(type: Class<S>): NamedDomainObjectList<S>