-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
FlowAction.java
82 lines (78 loc) · 2.82 KB
/
FlowAction.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
/*
* Copyright 2022 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.flow;
import org.gradle.api.Incubating;
import org.gradle.api.file.ArchiveOperations;
import org.gradle.api.file.FileSystemOperations;
import org.gradle.process.ExecOperations;
/**
* A dataflow action.
*
* <p>
* A parameterized and isolated piece of work that becomes eligible for execution within a
* {@link FlowScope dataflow scope} as soon as all of its input {@link FlowParameters parameters}
* become available.
* </p>
* <p>
* Implementations can benefit from constructor injection of services
* using the {@link javax.inject.Inject @Inject} annotation.
* Currently, only a small subset of services is supported:
* </p>
* <ul>
* <li>{@link ArchiveOperations} provides means to operate on archives such as ZIP or TAR files.</li>
* <li>{@link ExecOperations} provides means to execute external processes.</li>
* <li>{@link FileSystemOperations} provides means to operate on the file system.</li>
* </ul>
* <pre class='autoTested'>
* /**
* * Plays a given {{@literal @}link Parameters#getMediaFile() media file} using {{@literal @}code ffplay}.
* *{@literal /}
* class FFPlay implements FlowAction<FFPlay.Parameters> {
*
* interface Parameters extends FlowParameters {
* {@literal @}Input
* Property<File> getMediaFile();
* }
*
* private final ExecOperations execOperations;
*
* {@literal @}Inject
* FFPlay(ExecOperations execOperations) {
* this.execOperations = execOperations;
* }
*
* {@literal @}Override
* public void execute(Parameters parameters) throws Exception {
* execOperations.exec(spec -> {
* spec.commandLine(
* "ffplay", "-nodisp", "-autoexit", "-hide_banner", "-loglevel", "quiet",
* parameters.getMediaFile().get().getAbsolutePath()
* );
* spec.setIgnoreExitValue(true);
* });
* }
* }
* </pre>
*
* @param <P> Parameter type for the dataflow action. Should be {@link FlowParameters.None} if the action does not have parameters.
* @see FlowScope
* @see FlowProviders
* @since 8.1
*/
@Incubating
public interface FlowAction<P extends FlowParameters> {
void execute(P parameters) throws Exception;
}