1 /*
2  * Copyright 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 androidx.camera.camera2.pipe
18 
19 import androidx.annotation.RestrictTo
20 import kotlinx.atomicfu.atomic
21 
22 /**
23  * Identifier for a specific [CameraGraph] that can be used to standardize toString methods and as a
24  * key in maps without holding a reference to a [CameraGraph] object, which could lead to accidental
25  * memory leaks and circular dependencies.
26  */
27 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
28 public class CameraGraphId private constructor(private val name: String) {
toStringnull29     override fun toString(): String = name
30 
31     public companion object {
32         private val cameraGraphIds = atomic(0)
33 
34         /**
35          * Create the next CameraGraphId based on a global incrementing counter. This is
36          * intentionally worded as "CameraGraph" instead of "CameraGraphId" since it is used
37          * directly as the toString representation for a [CameraGraph].
38          */
39         @JvmStatic
40         public fun nextId(): CameraGraphId {
41             return CameraGraphId("CameraGraph-${cameraGraphIds.incrementAndGet()}")
42         }
43     }
44 }
45