• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
<lambda>null2  * Copyright (C) 2025 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.tools.metalava
18 
19 import com.android.tools.metalava.config.ApiFlagConfig
20 import com.android.tools.metalava.config.ApiFlagConfig.Mutability.IMMUTABLE
21 import com.android.tools.metalava.config.ApiFlagConfig.Mutability.MUTABLE
22 import com.android.tools.metalava.config.ApiFlagConfig.Status.DISABLED
23 import com.android.tools.metalava.config.ApiFlagConfig.Status.ENABLED
24 import com.android.tools.metalava.config.ApiFlagsConfig
25 import com.android.tools.metalava.model.api.flags.ApiFlag
26 import com.android.tools.metalava.model.api.flags.ApiFlags
27 import com.android.utils.associateNotNull
28 
29 /** Create [ApiFlags] from some source of information about the flags. */
30 object ApiFlagsCreator {
31     /** Create [ApiFlags] from [apiFlagsConfig]. */
32     fun createFromConfig(apiFlagsConfig: ApiFlagsConfig?): ApiFlags? {
33         return apiFlagsConfig?.createApiFlags()
34     }
35 
36     /** Create [ApiFlags] from [ApiFlagsConfig]. */
37     private fun ApiFlagsConfig.createApiFlags(): ApiFlags {
38         val byQualifiedName = flags.associateNotNull { config -> config.createApiFlag() }
39         return ApiFlags(byQualifiedName)
40     }
41 
42     /**
43      * Create [Pair] of qualified flag name and [ApiFlag] from [ApiFlagConfig].
44      *
45      * Returns `null` if [ApiFlagConfig.mutability] is [IMMUTABLE] and [ApiFlagConfig.status] is
46      * [DISABLED] as that is the default [ApiFlags.get] returns for flags that cannot be found.
47      */
48     private fun ApiFlagConfig.createApiFlag(): Pair<String, ApiFlag>? {
49         val apiFlag =
50             when (mutability) {
51                 MUTABLE -> ApiFlag.KEEP_FLAGGED_API
52                 IMMUTABLE ->
53                     when (status) {
54                         ENABLED -> ApiFlag.FINALIZE_FLAGGED_API
55                         DISABLED -> return null
56                     }
57             }
58         val qualifiedName = "$pkg.$name"
59         return Pair(qualifiedName, apiFlag)
60     }
61 }
62