1 /*
2  * Copyright (C) 2022 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 package com.android.tools.metalava
17 
18 /**
19  * ID and aliases for a given SDK.
20  *
21  * SDKs include the Android SDK and SDK extensions (e.g. the T extensions).
22  *
23  * @param id: numerical ID of the SDK, primarily used in generated artifacts and consumed by tools
24  * @param shortname: short name for the SDK, primarily used in configuration files
25  * @param name: human readable name for the SDK; used in the official documentation
26  * @param reference: Java symbol in the Android SDK with the same numerical value as the id, using a
27  *   JVM signature like syntax: "some/clazz$INNER$FIELD"
28  */
29 data class SdkIdentifier(
30     val id: Int,
31     val shortname: String,
32     val name: String,
33     val reference: String
34 )
35