xref: /aosp_15_r20/tools/metalava/metalava-model/src/main/java/com/android/tools/metalava/model/FixedDefaultValue.kt (revision 115816f9299ab6ddd6b9673b81f34e707f6bacab)
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
18 
19 import com.android.tools.metalava.model.item.DefaultValue
20 
21 /** Encapsulates information about a fixed default value. */
22 internal class FixedDefaultValue(private val value: String?) : DefaultValue {
23 
24     /** This is always true as the text model will use [DefaultValue.NONE] for no value. */
hasDefaultValuenull25     override fun hasDefaultValue() = true
26 
27     /** This is always true as the text model will use [DefaultValue.UNKNOWN] for no value. */
28     override fun isDefaultValueKnown() = true
29 
30     override fun value() = value
31 
32     /** This is suitable for use by [parameter] as it has no model or codebase dependencies. */
33     override fun duplicate(parameter: ParameterItem) = this
34 
35     /** This is suitable for use in the snapshot as it has no model or codebase dependencies. */
36     override fun snapshot(parameter: ParameterItem) = this
37 
38     override fun toString() = "DefaultValue($value)"
39 }
40