org.gradle.api.tasks

インタフェース TaskCollection<T extends Task>

型パラメータ:

T - The type of tasks which this collection contains.

すべてのスーパーインタフェース:

Collection<T>, DomainObjectCollection<T>, Iterable<T>, NamedDomainObjectCollection<T>, NamedDomainObjectSet<T>, Set<T>

既知のサブインタフェースのリスト:

TaskContainer

public interface TaskCollection<T extends Task>
extends NamedDomainObjectSet<T>

A TaskCollection contains a set of Task instances, and provides a number of query methods.

メソッドの概要

修飾子とタイプ	メソッドと説明
T	getAt(String name) Locates an object by name, failing if there is no such task.
T	getByName(String name) Locates an object by name, failing if there is no such object.
T	getByName(String name, Closure configureClosure) Locates an object by name, failing if there is no such object.
TaskCollection<T>	matching(Closure closure) Returns a collection which contains the objects in this collection which meet the given closure specification.
TaskCollection<T>	matching(Spec<? super T> spec) Returns a collection which contains the objects in this collection which meet the given specification.
Action<? super T>	whenTaskAdded(Action<? super T> action) Adds an Action to be executed when a task is added to this collection.
void	whenTaskAdded(Closure closure) Adds a closure to be called when a task is added to this collection.
<S extends T> TaskCollection<S>	withType(Class<S> type) Returns a collection containing the objects in this collection of the given type.

インタフェースから継承されたメソッド org.gradle.api.NamedDomainObjectSet

findAll

インタフェースから継承されたメソッド org.gradle.api.NamedDomainObjectCollection

add, addAll, addRule, addRule, findByName, getAsMap, getNamer, getNames, getRules

インタフェースから継承されたメソッド org.gradle.api.DomainObjectCollection

all, all, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType

インタフェースから継承されたメソッド java.util.Collection

clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

インタフェースから継承されたメソッド java.lang.Iterable

forEach

インタフェースから継承されたメソッド java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

メソッドの詳細

matching

TaskCollection<T> matching(Spec<? super T> spec)

Returns a collection which contains the objects in this collection which meet the given specification. The returned collection is live, so that when matching objects are added to this collection, they are also visible in the filtered collection.

定義:

matching インタフェース内 DomainObjectCollection<T extends Task>

定義:

matching インタフェース内 NamedDomainObjectCollection<T extends Task>

定義:

matching インタフェース内 NamedDomainObjectSet<T extends Task>

パラメータ:

spec - The specification to use.

戻り値:

The collection of matching objects. Returns an empty collection if there are no such objects in this collection.

matching

TaskCollection<T> matching(Closure closure)

Returns a collection which contains the objects in this collection which meet the given closure specification. The returned collection is live, so that when matching objects are added to this collection, they are also visible in the filtered collection.

定義:

matching インタフェース内 DomainObjectCollection<T extends Task>

定義:

matching インタフェース内 NamedDomainObjectCollection<T extends Task>

定義:

matching インタフェース内 NamedDomainObjectSet<T extends Task>

パラメータ:

closure - The specification to use. The closure gets a collection element as an argument.

戻り値:

The collection of matching objects. Returns an empty collection if there are no such objects in this collection.

getByName

T getByName(String name,
            Closure configureClosure)
     throws UnknownTaskException

Locates an object by name, failing if there is no such object. The given configure closure is executed against the object before it is returned from this method. The object is passed to the closure as its delegate.

定義:

getByName インタフェース内 NamedDomainObjectCollection<T extends Task>

パラメータ:

name - The object name

configureClosure - The closure to use to configure the object.

戻り値:

The object with the given name, after the configure closure has been applied to it. Never returns null.

例外:

UnknownTaskException

getByName

T getByName(String name)
     throws UnknownTaskException

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

定義:

getByName インタフェース内 NamedDomainObjectCollection<T extends Task>

パラメータ:

name - The object name

戻り値:

The object with the given name. Never returns null.

例外:

UnknownTaskException

withType

<S extends T> TaskCollection<S> withType(Class<S> type)

Returns a collection containing the objects in this collection of the given type. The returned collection is live, so that when matching objects are later added to this collection, they are also visible in the filtered collection.

定義:

withType インタフェース内 DomainObjectCollection<T extends Task>

定義:

withType インタフェース内 NamedDomainObjectCollection<T extends Task>

定義:

withType インタフェース内 NamedDomainObjectSet<T extends Task>

パラメータ:

type - The type of objects to find.

戻り値:

The matching objects. Returns an empty collection if there are no such objects in this collection.

whenTaskAdded

Action<? super T> whenTaskAdded(Action<? super T> action)

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

パラメータ:

action - The action to be executed

戻り値:

the supplied action

whenTaskAdded

void whenTaskAdded(Closure closure)

Adds a closure to be called when a task is added to this collection. The task is passed to the closure as the parameter.

パラメータ:

closure - The closure to be called

getAt

T getAt(String name)
 throws UnknownTaskException

Locates an object by name, failing if there is no such task. This method is identical to NamedDomainObjectCollection.getByName(String). You can call this method in your build script by using the groovy [] operator.

定義:

getAt インタフェース内 NamedDomainObjectCollection<T extends Task>

パラメータ:

name - The object name

戻り値:

The object with the given name. Never returns null.

例外:

UnknownTaskException