summaryrefslogtreecommitdiff
path: root/build-system/gradle-api/src/main/java/com/android/build/api/variant/VariantSelector.kt
blob: efba0488c89fc26c45912dde2d1b4fd1b941106a (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
/*
 * 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 java.util.regex.Pattern

/**
 * Selector to reduce the number of variants that are of interests when calling any of the
 * variant API like [AndroidComponentsExtension.beforeVariants].
 */
interface VariantSelector {
    /**
     * Creates a [VariantSelector] of [ComponentIdentity] that includes all the variants for the
     * current module.
     *
     * @return a [VariantSelector] for all variants.
     */
    fun all(): VariantSelector

    /**
     * Returns a new selector for [ComponentIdentity] objects with a given build type.
     *
     * @param buildType Build type to filter [ComponentIdentity] on.
     * @return An instance of [VariantSelector] to further filter variants.
     */
    fun withBuildType(buildType: String): VariantSelector

    /**
     * Returns a new selector for [ComponentIdentity] objects with a given (dimension, flavorName).
     *
     * @param flavorToDimension Dimension and flavor to filter [ComponentIdentity] on.
     * @return [VariantSelector] instance to further filter instances of [ComponentIdentity]
     */
    fun withFlavor(flavorToDimension: Pair<String, String>): VariantSelector

    /**
     * Returns a new selector for [ComponentIdentity]  objects with a given name pattern.
     *
     * @param pattern [Pattern] to apply on the [org.gradle.api.Named.getName] to filter [ComponentIdentity]
     * instances on
     */
    fun withName(pattern: Pattern): VariantSelector

    /**
     * Returns a new selector for [ComponentIdentity]  objects with a given name.
     *
     * @param name [String] to test against the [org.gradle.api.Named.getName] for equality.
     */
    fun withName(name: String): VariantSelector
}