-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
WorkParameters.java
46 lines (44 loc) · 1.4 KB
/
WorkParameters.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
/*
* Copyright 2019 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.workers;
/**
* Marker interface for parameter objects to {@link WorkAction}s.
*
* <p>
* Parameter types should be interfaces, only declaring getters for {@link org.gradle.api.provider.Property}-like objects.
* Example:
* </p>
* <pre class='autoTested'>
* public interface MyParameters extends WorkParameters {
* Property<String> getStringParameter();
* ConfigurableFileCollection getFiles();
* }
* </pre>
*
* @since 5.6
*/
public interface WorkParameters {
/**
* Used for work actions without parameters.
*
* <p>When {@link None} is used as parameters, calling {@link WorkAction#getParameters()} throws an exception.</p>
*
* @since 5.6
*/
final class None implements WorkParameters {
private None() {}
}
}