-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
JavaToolchainService.java
78 lines (69 loc) · 2.76 KB
/
JavaToolchainService.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
/*
* Copyright 2020 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.jvm.toolchain;
import org.gradle.api.Action;
import org.gradle.api.provider.Provider;
/**
* Allows to query for toolchain managed tools, like {@link JavaCompiler}, {@link JavaLauncher} and {@link JavadocTool}.
* <p>
* An instance of this service is available for injection into tasks, plugins and other types.
*
* @since 6.7
*/
public interface JavaToolchainService {
/**
* Obtain a {@link JavaCompiler} matching the {@link JavaToolchainSpec}, as configured by the provided action.
*
* @param config The configuration of the {@code JavaToolchainSpec}
* @return A {@code Provider<JavaCompiler>}
*/
Provider<JavaCompiler> compilerFor(Action<? super JavaToolchainSpec> config);
/**
* Obtain a {@link JavaCompiler} matching the {@link JavaToolchainSpec}.
*
* @param spec The {@code JavaToolchainSpec}
* @return A {@code Provider<JavaCompiler>}
*/
Provider<JavaCompiler> compilerFor(JavaToolchainSpec spec);
/**
* Obtain a {@link JavaLauncher} matching the {@link JavaToolchainSpec}, as configured by the provided action.
*
* @param config The configuration of the {@code JavaToolchainSpec}
* @return A {@code Provider<JavaLauncher>}
*/
Provider<JavaLauncher> launcherFor(Action<? super JavaToolchainSpec> config);
/**
* Obtain a {@link JavaLauncher} matching the {@link JavaToolchainSpec}.
*
* @param spec The {@code JavaToolchainSpec}
* @return A {@code Provider<JavaLauncher>}
*/
Provider<JavaLauncher> launcherFor(JavaToolchainSpec spec);
/**
* Obtain a {@link JavadocTool} matching the {@link JavaToolchainSpec}, as configured by the provided action.
*
* @param config The configuration of the {@code JavaToolchainSpec}
* @return A {@code Provider<JavadocTool>}
*/
Provider<JavadocTool> javadocToolFor(Action<? super JavaToolchainSpec> config);
/**
* Obtain a {@link JavadocTool} matching the {@link JavaToolchainSpec}.
*
* @param spec The {@code JavaToolchainSpec}
* @return A {@code Provider<JavadocTool>}
*/
Provider<JavadocTool> javadocToolFor(JavaToolchainSpec spec);
}