1 /*
2  * Copyright 2021 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.core.impl;
18 
19 import com.google.auto.value.AutoValue;
20 
21 import org.jspecify.annotations.NonNull;
22 
23 /**
24  * The {@link Identifier} class allows anything to be wrapped as an {@link Identifier} instance.
25  * The caller should make the input value object unique when calling the {@link #create(Object)}
26  * function. So that the {@link Identifier} can be recognized and used for specific purposes.
27  */
28 @AutoValue
29 public abstract class Identifier {
30     /**
31      * Creates an {@link Identifier} for the specified input value.
32      */
create(@onNull Object value)33     public static @NonNull Identifier create(@NonNull Object value) {
34         return new AutoValue_Identifier(value);
35     }
36 
37     /**
38      * Retrieves the value of this {@link Identifier}.
39      */
getValue()40     public abstract @NonNull Object getValue();
41 }
42