Groovy Documentation

org.gradle.api.tasks
[Java] Interface TaskCollection

org.gradle.api.tasks.TaskCollection
  java.lang.Iterable
      org.gradle.api.NamedDomainObjectSet
          org.gradle.api.DomainObjectCollection
              org.gradle.api.NamedDomainObjectCollection
                  java.util.Collection
All Superinterfaces:
java.lang.Iterable, NamedDomainObjectSet, DomainObjectCollection, NamedDomainObjectCollection, java.util.Collection

public interface TaskCollection
extends NamedDomainObjectSet

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

Parameters:
- The type of tasks which this collection contains.


Method Summary
void allTasks(Action action)

Executes the given action against all tasks in this collection, and any tasks subsequently added to this collection.

void allTasks(groovy.lang.Closure closure)

Executes the given closure against all tasks in this collection, and any tasks subsequently added to this collection.

java.lang.Object getAt(java.lang.String name)

{@inheritDoc}

java.lang.Object getByName(java.lang.String name, groovy.lang.Closure configureClosure)

{@inheritDoc}

java.lang.Object getByName(java.lang.String name)

{@inheritDoc}

TaskCollection matching(Spec spec)

{@inheritDoc}

TaskCollection matching(groovy.lang.Closure closure)

{@inheritDoc}

Action whenTaskAdded(Action action)

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

void whenTaskAdded(groovy.lang.Closure closure)

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

TaskCollection withType(java.lang.Class type)

{@inheritDoc}

 
Methods inherited from interface NamedDomainObjectSet
findAll, matching, matching, withType
 
Methods inherited from interface java.util.Set
java.util.Set#add(java.lang.Object), java.util.Set#equals(java.lang.Object), java.util.Set#hashCode(), java.util.Set#clear(), java.util.Set#isEmpty(), java.util.Set#contains(java.lang.Object), java.util.Set#addAll(java.util.Collection), java.util.Set#size(), java.util.Set#toArray([Ljava.lang.Object;), java.util.Set#toArray(), java.util.Set#iterator(), java.util.Set#remove(java.lang.Object), java.util.Set#removeAll(java.util.Collection), java.util.Set#containsAll(java.util.Collection), java.util.Set#retainAll(java.util.Collection)
 
Methods inherited from interface NamedDomainObjectCollection
add, addAll, addRule, addRule, findByName, getAsMap, getAt, getByName, getByName, getNamer, getRules, matching, matching, withType
 
Methods inherited from interface DomainObjectCollection
all, all, allObjects, allObjects, findAll, findAll, getAll, matching, matching, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withType, withType
 

Method Detail

allTasks

@Deprecated
public void allTasks(Action action)
Executes the given action against all tasks in this collection, and any tasks subsequently added to this collection.
deprecated:
Use all(org.gradle.api.Action) instead.
Parameters:
action - The action to be executed


allTasks

@Deprecated
public void allTasks(groovy.lang.Closure closure)
Executes the given closure against all tasks in this collection, and any tasks subsequently added to this collection.
deprecated:
Use all(groovy.lang.Closure) instead.
Parameters:
closure - The closure to be called


getAt

public java.lang.Object getAt(java.lang.String name)
{@inheritDoc}


getByName

public java.lang.Object getByName(java.lang.String name, groovy.lang.Closure configureClosure)
{@inheritDoc}


getByName

public java.lang.Object getByName(java.lang.String name)
{@inheritDoc}


matching

public TaskCollection matching(Spec spec)
{@inheritDoc}


matching

public TaskCollection matching(groovy.lang.Closure closure)
{@inheritDoc}


whenTaskAdded

public Action whenTaskAdded(Action action)
Adds an Action to be executed when a task is added to this collection.
Parameters:
action - The action to be executed
Returns:
the supplied action


whenTaskAdded

public void whenTaskAdded(groovy.lang.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.
Parameters:
closure - The closure to be called


withType

public TaskCollection withType(java.lang.Class type)
{@inheritDoc}


 

Groovy Documentation