gradle/org.gradle.api.tasks/TaskContainer

TaskContainer

interface TaskContainer : TaskCollection<Task> , PolymorphicDomainObjectContainer<Task> (source)

A TaskContainer is responsible for managing a set of Task instances.

You can obtain a TaskContainer instance by calling getTasks, or using the tasks property in your build script.

Functions

add

abstract fun add(p: E): Boolean

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.

addAll

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

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.

addLater

abstract fun addLater(provider: Provider<out T>)

Adds an element to this collection, given a Provider that will provide the element when required.

addRule

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

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

abstract fun clear()

configure

abstract fun configure(configureClosure: Closure): NamedDomainObjectContainer<T>

Allows the container to be configured, creating missing objects as they are referenced.

abstract fun configure(cl: Closure): T

configureEach

abstract fun configureEach(action: Action<in T>)

Configures each element in this collection using the given action, as each element is required.

containerWithType

abstract fun containerWithType(type: Class): NamedDomainObjectContainer

Creates a regular container that wraps the polymorphic container presenting all elements of a specified type.

contains

abstract fun contains(p: Any): Boolean

containsAll

abstract fun containsAll(p: Collection<out Any>): Boolean

copyOf

open fun <E> copyOf(coll: Collection<out E>): Set<E>

create

abstract fun ~~create~~(name: String): Task

Creates a Task with the given name and adds it to this container.

abstract fun ~~create~~(options: Map<String, out Any>): Task

Creates a Task and adds it to this container.

abstract fun ~~create~~(name: String, configureClosure: Closure): Task

Creates a Task with the given name adds it to this container.

abstract fun <T : Task?> ~~create~~(name: String, type: Class<T>): T

Creates a Task with the given name and type, and adds it to this container.

abstract fun ~~create~~(name: String, configuration: Action<in Task>): Task

Creates a Task with the given name and of type org.gradle.api.DefaultTask, configures it with the given action, and adds it to this container.

abstract fun ~~create~~(options: Map<String, out Any>, configureClosure: Closure): Task

Creates a Task adds it to this container.

abstract fun <T : Task?> ~~create~~(name: String, type: Class<T>, constructorArgs: Array<Any>): T

Creates a Task with the given name and type, passing the given arguments to the @Inject-annotated constructor, and adds it to this container.

abstract fun <T : Task?> ~~create~~(name: String, type: Class<T>, configuration: Action<in T>): T

Creates a Task with the given name and type, configures it with the given action, and adds it to this container.

disallowChanges

@Incubating

open fun disallowChanges()

Disallows further structural modifications to this collection.

equals

abstract fun equals(p: Any): Boolean

findAll

abstract fun ~~findAll~~(spec: Closure): Collection<T>

abstract fun ~~findAll~~(spec: Closure): Set<T>

Returns a collection which contains the objects in this collection which meet the given closure specification.

findByName

@Nullable

abstract fun findByName(name: String): @Nullable T

Locates an object by name, returning null if there is no such object.

findByPath

@Nullable

abstract fun findByPath(path: String): @Nullable Task

Locates a task by path.

forEach

open fun forEach(action: Consumer<in T>)

getAsMap

abstract fun getAsMap(): SortedMap<String, T>

Returns the objects in this collection, as a map from object name to object instance.

getAt

abstract fun getAt(name: String): T

Locates an object by name, failing if there is no such object.

getByName

abstract fun getByName(name: String, configureAction: Action<in T>): T

abstract fun getByName(name: String): T

abstract fun getByName(name: String, configureClosure: Closure): T

Locates an object by name, failing if there is no such object.

getByPath

abstract fun getByPath(path: String): Task

Locates a task by path.

getCollectionSchema

@Internal

abstract fun getCollectionSchema(): NamedDomainObjectCollectionSchema

Provides access to the schema of all created or registered named domain objects in this collection.

getNamer

abstract fun getNamer(): Namer<T>

An object that represents the naming strategy used to name objects of this collection.

getNames

abstract fun getNames(): SortedSet<String>

Returns the names of the objects in this collection as a Set of Strings.

getRules

abstract fun getRules(): List<Rule>

Returns the rules used by this collection.

hashCode

abstract fun hashCode(): Int

isEmpty

abstract fun isEmpty(): Boolean

iterator

abstract fun iterator(): Iterator<T>

abstract fun iterator(): Iterator<E>

matching

abstract fun matching(spec: Closure): DomainObjectCollection<T>

abstract fun matching(spec: Closure): DomainObjectSet<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>): DomainObjectSet<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): NamedDomainObjectSet<T>

abstract fun matching(spec: Spec<in T>): NamedDomainObjectSet<T>

abstract fun matching(closure: Closure): TaskCollection<T>

abstract fun matching(spec: Spec<in T>): TaskCollection<T>

maybeCreate

abstract fun maybeCreate(name: String): T

Looks for an item with the given name, creating and adding it to this container if it does not exist.

abstract fun maybeCreate(name: String, type: Class): U

Looks for an item with the given name and type, creating and adding it to this container if it does not exist.

named

abstract fun named(name: String): NamedDomainObjectProvider<T>

abstract fun named(name: String, configurationAction: Action<in T>): NamedDomainObjectProvider<T>

abstract fun named(name: String, configurationAction: Action<in T>): TaskProvider<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>): NamedDomainObjectSet<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>

abstract fun <S : T?> named(name: String, type: Class<S>): TaskProvider<S>

abstract fun <S : T?> named(name: String, type: Class<S>, configurationAction: Action<in S>): TaskProvider<S>

Locates a object by name and type, failing if there is no such object.

abstract fun named(name: String): TaskProvider<T>

Locates a task by name, without triggering its creation or configuration, failing if there is no such object.

abstract fun named(nameFilter: Spec<String>): TaskCollection<T>

open fun <E> of(): Set<E>

parallelStream

open fun parallelStream(): Stream<E>

abstract fun register(name: String): TaskProvider<Task>

abstract fun <T : Task?> register(name: String, type: Class<T>): TaskProvider<T>

Defines a new task, which will be created when it is required.

abstract fun register(name: String, configurationAction: Action<in Task>): TaskProvider<Task>

abstract fun <T : Task?> register(name: String, type: Class<T>, configurationAction: Action<in T>): TaskProvider<T>

Defines a new task, which will be created and configured when it is required.

abstract fun <T : Task?> register(name: String, type: Class<T>, constructorArgs: Array<Any>): TaskProvider<T>

Defines a new task, which will be created when it is required passing the given arguments to the @Inject-annotated constructor.

remove

abstract fun remove(p: Any): Boolean

removeAll

abstract fun removeAll(p: Collection<out Any>): Boolean

removeIf

open fun removeIf(filter: Predicate<in E>): Boolean

replace

abstract fun replace(name: String): Task

Creates a Task with the given name and adds it to this container, replacing any existing task with the same name.

abstract fun <T : Task?> replace(name: String, type: Class<T>): T

Creates a Task with the given name and type, and adds it to this container, replacing any existing task of the same name.

retainAll

abstract fun retainAll(p: Collection<out Any>): Boolean

size

abstract fun size(): Int

spliterator

open fun spliterator(): Spliterator<T>

open fun spliterator(): Spliterator<E>

stream

open fun stream(): Stream<E>

toArray

abstract fun toArray(): Array<Any>

abstract fun <T> toArray(p: Array<T>): Array<T>

whenObjectAdded

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

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.

whenTaskAdded

abstract fun whenTaskAdded(closure: Closure)

Adds a closure to be called when a task is added to this collection.

abstract fun whenTaskAdded(action: Action<in T>): Action<in T>

Adds an Action to be executed when a task is added to this collection.

withType

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>): DomainObjectSet<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>): NamedDomainObjectSet<S>

abstract fun <S : T?> withType(type: Class<S>): TaskCollection<S>