-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
ExecOutput.java
99 lines (92 loc) · 3.28 KB
/
ExecOutput.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
/*
* Copyright 2021 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.process;
import org.gradle.api.Incubating;
import org.gradle.api.provider.Provider;
/**
* Provides lazy access to the output of the external process.
*
* @since 7.5
*/
@Incubating
public interface ExecOutput {
/**
* Returns a provider of the execution result.
*
* <p>
* The external process is executed only once and only when the value is requested for the first
* time.
* </p>
* <p>
* If starting the process results in exception then the ensuing exception is permanently
* propagated to callers of {@link Provider#get}, {@link Provider#getOrElse},
* {@link Provider#getOrNull} and {@link Provider#isPresent}.
* </p>
*
* @return provider of the execution result.
*/
Provider<ExecResult> getResult();
/**
* Gets a handle to the content of the process' standard output.
*
* @return handle of the standard output of the process.
*/
StandardStreamContent getStandardOutput();
/**
* Gets a handle to the content of the process' standard error output.
*
* @return handle of the standard error output of the process.
*/
StandardStreamContent getStandardError();
/**
* A handle to access content of the process' standard stream (the standard output of the
* standard error output).
*
* @since 7.5
*/
@Incubating
interface StandardStreamContent {
/**
* Gets a provider for the standard stream's content that returns it as a String. The output
* is decoded using the default encoding of the JVM running the build.
*
* <p>
* The external process is executed only once and only when the value is requested for the
* first time.
* </p>
* <p>
* If starting the process results in exception then the ensuing exception is permanently
* propagated to callers of {@link Provider#get}, {@link Provider#getOrElse},
* {@link Provider#getOrNull} and {@link Provider#isPresent}.
* </p>
*/
Provider<String> getAsText();
/**
* Gets a provider for the standard stream's content that returns it as a byte array.
*
* <p>
* The external process is executed only once and only when the value is requested for the
* first time.
* </p>
* <p>
* If starting the process results in exception then the ensuing exception is permanently
* propagated to callers of {@link Provider#get}, {@link Provider#getOrElse},
* {@link Provider#getOrNull} and {@link Provider#isPresent}.
* </p>
*/
Provider<byte[]> getAsBytes();
}
}