-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
TaskCollection.java
132 lines (117 loc) · 3.68 KB
/
TaskCollection.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*
* Copyright 2009 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.api.tasks;
import groovy.lang.Closure;
import org.gradle.api.Action;
import org.gradle.api.NamedDomainObjectSet;
import org.gradle.api.Task;
import org.gradle.api.UnknownTaskException;
import org.gradle.api.provider.Provider;
import org.gradle.api.specs.Spec;
/**
* A {@code TaskCollection} contains a set of {@link Task} instances, and provides a number of query methods.
*
* @param <T> The type of tasks which this collection contains.
*/
public interface TaskCollection<T extends Task> extends NamedDomainObjectSet<T> {
/**
* {@inheritDoc}
*/
@Override
TaskCollection<T> named(Spec<String> nameFilter);
/**
* {@inheritDoc}
*/
@Override
TaskCollection<T> matching(Spec<? super T> spec);
/**
* {@inheritDoc}
*/
@Override
TaskCollection<T> matching(Closure closure);
/**
* {@inheritDoc}
*/
@Override
T getByName(String name, Closure configureClosure) throws UnknownTaskException;
/**
* {@inheritDoc}
*/
@Override
T getByName(String name) throws UnknownTaskException;
/**
* {@inheritDoc}
*/
@Override
<S extends T> TaskCollection<S> withType(Class<S> type);
/**
* Adds an {@code Action} to be executed when a task is added to this collection.
* <p>
* Like {@link #all(Action)}, this method will cause all tasks in this container to be realized.
* </p>
*
* @param action The action to be executed
* @return the supplied action
*/
@SuppressWarnings("UnusedDeclaration")
Action<? super T> whenTaskAdded(Action<? super T> action);
/**
* Adds a closure to be called when a task is added to this collection. The task is passed to the closure as the
* parameter.
*
* @param closure The closure to be called
* @see #whenTaskAdded(Action)
*/
@SuppressWarnings("UnusedDeclaration")
void whenTaskAdded(Closure closure);
/**
* {@inheritDoc}
*/
@Override
T getAt(String name) throws UnknownTaskException;
/**
* Locates a task by name, without triggering its creation or configuration, failing if there is no such object.
*
*
* @param name The task name
* @return A {@link Provider} that will return the task when queried. The task may be created and configured at this point, if not already.
* @throws UnknownTaskException If a task with the given name is not defined.
* @since 4.9
*/
@Override
TaskProvider<T> named(String name) throws UnknownTaskException;
/**
* {@inheritDoc}
*
* @since 5.0
*/
@Override
TaskProvider<T> named(String name, Action<? super T> configurationAction) throws UnknownTaskException;
/**
* {@inheritDoc}
*
* @since 5.0
*/
@Override
<S extends T> TaskProvider<S> named(String name, Class<S> type) throws UnknownTaskException;
/**
* {@inheritDoc}
*
* @since 5.0
*/
@Override
<S extends T> TaskProvider<S> named(String name, Class<S> type, Action<? super S> configurationAction) throws UnknownTaskException;
}