xref: /aosp_15_r20/tools/metalava/metalava-model/src/main/java/com/android/tools/metalava/model/item/FieldValue.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.item
18 
19 import com.android.tools.metalava.model.FixedFieldValue
20 
21 interface FieldValue {
initialValuenull22     fun initialValue(requireConstant: Boolean): Any?
23 
24     /**
25      * Creates a snapshot of this.
26      *
27      * The default implementation assumes that this is either dependent on a model or the codebase
28      * and so creates a new [FixedFieldValue] based on the functions above.
29      */
30     fun snapshot(): FieldValue = FixedFieldValue(initialValue(true), initialValue(false))
31 }
32