-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
KotlinDslScriptsModel.java
61 lines (55 loc) · 2.64 KB
/
KotlinDslScriptsModel.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
/*
* 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.tooling.model.kotlin.dsl;
import java.io.File;
import java.util.Map;
/**
* Editor model for a set of Kotlin DSL scripts.
* <p>
* Can only be requested on the root project, the builder will throw otherwise.
* <p>
* Requires the <code>prepareKotlinBuildScriptModel</code> task to be executed before building the model.
* See {@link KotlinDslModelsParameters#PREPARATION_TASK_NAME}
* <p>
* The set of scripts can be provided as a Gradle property named <code>org.gradle.kotlin.dsl.provider.scripts</code>,
* as a list of absolute paths separated by <code>|</code>.
* If none are provided, then the model is built for all the Kotlin DSL scripts known to belong to this build.
* See {@link KotlinDslScriptsModel#SCRIPTS_GRADLE_PROPERTY_NAME}.
* <p>
* The Gradle Kotlin DSL script provider must be running in "classpath" mode.
* This is done by providing the system property <code>-Dorg.gradle.kotlin.dsl.provider.mode=classpath</code>.
* See {@link KotlinDslModelsParameters#CLASSPATH_MODE_SYSTEM_PROPERTY_DECLARATION}.
* In this mode, Gradle Kotlin DSL scripts compilation or evaluation failures will be ignored, collected and
* exceptions will be returned in the built model.
* Optionally, it can also be set in a strict mode by providing the system property value <code>-Dorg.gradle.kotlin.dsl.provider.mode=strict-classpath</code>.
* See {@link KotlinDslModelsParameters#STRICT_CLASSPATH_MODE_SYSTEM_PROPERTY_DECLARATION}.
* <p>
* Optionally, an identifier can be provided as a Gradle property named <code>org.gradle.kotlin.dsl.provider.cid</code>,
* it can then be used to correlate Gradle and TAPI client log statements.
* See {@link KotlinDslModelsParameters#CORRELATION_ID_GRADLE_PROPERTY_NAME}.
*
* @since 6.0
*/
public interface KotlinDslScriptsModel {
/**
* Gradle property name for the set of scripts to be queried for.
*/
String SCRIPTS_GRADLE_PROPERTY_NAME = "org.gradle.tooling.model.kotlin.dsl.scripts";
/**
* Script models by file.
*/
Map<File, KotlinDslScriptModel> getScriptModels();
}