summaryrefslogtreecommitdiff
path: root/build-system/gradle-api/src/main/java/com/android/build/api/variant/Sources.kt
blob: ea03c3adf43d7c84fce27c76c1d369b0a075e59e (plain)
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
/*
 * Copyright (C) 2021 The Android Open Source Project
 *
 * 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 com.android.build.api.variant

import org.gradle.api.Incubating

/**
 * Provides access to all source directories for a [Variant].
 *
 * since 7.2
 */
@Incubating
interface Sources {

    /**
     * Access to the Java source folders.
     */
    val java: SourceDirectories.Flat?

    /**
     * Access ot the Kotlin source folders.
     */
    val kotlin: SourceDirectories.Flat?

    /**
     * Access to the Android resources sources folders.
     */
    val res: SourceDirectories.Layered?

    /**
     * Access to the Java-style resources sources folders.
     */
    val resources: SourceDirectories.Flat?

    /**
     * Access to the Android assets sources folders.
     */
    val assets: SourceDirectories.Layered?

    /**
     * Access to the JNI libraries folders
     */
    val jniLibs: SourceDirectories.Layered?

    /**
     * Access to the shaders sources folders if [com.android.build.api.dsl.BuildFeatures.shaders]
     * is true otherwise null
     */
    val shaders: SourceDirectories.Layered?

    /**
     * Access to the machine learning models folders.
     */
    val mlModels: SourceDirectories.Layered?

    /**
     * Access to the aidl sources folders if [com.android.build.api.dsl.BuildFeatures.aidl]
     * is true otherwise null
     */
    val aidl: SourceDirectories.Flat?

    /**
     * Access to the renderscript sources folders if
     * [com.android.build.api.dsl.BuildFeatures.renderScript] is true otherwise null.
     */
    @get:Deprecated("renderscript is deprecated and will be removed in a future release.")
    val renderscript: SourceDirectories.Flat?

    /**
     * Access (and potentially creates) a new [Flat] for a custom source type that can
     * be referenced by its [name].
     *
     * The first caller will create the new instance, other callers with the same [name] will get
     * the same instance returned. Any callers can obtain the final list of the folders registered
     * under this custom source type by calling [Flat.all].
     *
     * These sources directories are attached to the variant and will be visible to Android Studio.
     */
    fun getByName(name: String): SourceDirectories.Flat
}