1 /* 2 * Copyright (C) 2024 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.model.api.surface 18 19 /** A specific API surface. */ 20 sealed interface ApiSurface { 21 /** The set of [ApiSurface]s to which this belongs. */ 22 val surfaces: ApiSurfaces 23 24 /** The name of the surface. */ 25 val name: String 26 27 /** The optional [ApiSurface] that this extends. */ 28 val extends: ApiSurface? 29 30 /** True if this is the main [ApiSurface] being generated. */ 31 val isMain: Boolean 32 33 /** The list of [ApiVariant]s, in the same order as [ApiVariantType]s. */ 34 val variants: List<ApiVariant> 35 36 /** The set of all [ApiVariant]s in this [ApiSurface]. */ 37 val variantSet: ApiVariantSet 38 39 /** Get the [ApiVariant] for [ApiVariantType] in this [ApiSurface]. */ variantFornull40 fun variantFor(type: ApiVariantType): ApiVariant 41 } 42