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 /** 20 * A specific API surface. 21 * 22 * Their natural ordering is determined by the order in which they were created in [surfaces]. 23 */ 24 sealed interface ApiSurface : Comparable<ApiSurface> { 25 /** The set of [ApiSurface]s to which this belongs. */ 26 val surfaces: ApiSurfaces 27 28 /** The name of the surface. */ 29 val name: String 30 31 /** The optional [ApiSurface] that this extends. */ 32 val extends: ApiSurface? 33 34 /** True if this is the main [ApiSurface] being generated. */ 35 val isMain: Boolean 36 37 /** The list of [ApiVariant]s, in the same order as [ApiVariantType]s. */ 38 val variants: List<ApiVariant> 39 40 /** The set of all [ApiVariant]s in this [ApiSurface]. */ 41 val variantSet: ApiVariantSet 42 43 /** Get the [ApiVariant] for [ApiVariantType] in this [ApiSurface]. */ variantFornull44 fun variantFor(type: ApiVariantType): ApiVariant 45 } 46