1 /*
2  * Copyright (C) 2023 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 android.car.hardware.property;
18 
19 import android.annotation.IntDef;
20 import android.annotation.NonNull;
21 import android.annotation.SystemApi;
22 
23 import java.lang.annotation.Retention;
24 import java.lang.annotation.RetentionPolicy;
25 
26 /**
27  * Used to enumerate the current state of {@link
28  * android.car.VehiclePropertyIds#FORWARD_COLLISION_WARNING_STATE}.
29  *
30  * <p>This list of states may be extended in future releases to include additional states.
31  * @hide
32  */
33 @SystemApi
34 public final class ForwardCollisionWarningState {
35     /**
36      * This state is used as an alternative for any {@code ForwardCollisionWarningState} value that
37      * is not defined in the platform. Ideally, implementations of {@link
38      * android.car.VehiclePropertyIds#FORWARD_COLLISION_WARNING_STATE} should not use this state.
39      * The framework can use this field to remain backwards compatible if {@code
40      * ForwardCollisionWarningState} is extended to include additional states.
41      */
42     public static final int OTHER = 0;
43 
44     /**
45      * FCW is enabled and monitoring safety, but no potential collision is detected.
46      */
47     public static final int NO_WARNING = 1;
48 
49     /**
50      * FCW is enabled, detects a potential collision, and is actively warning the user.
51      */
52     public static final int WARNING = 2;
53 
ForwardCollisionWarningState()54     private ForwardCollisionWarningState() {}
55 
56     /**
57      * Returns a user-friendly representation of a {@code ForwardCollisionWarningState}.
58      */
59     @NonNull
toString( @orwardCollisionWarningStateInt int forwardCollisionWarningState)60     public static String toString(
61             @ForwardCollisionWarningStateInt int forwardCollisionWarningState) {
62         switch (forwardCollisionWarningState) {
63             case OTHER:
64                 return "OTHER";
65             case NO_WARNING:
66                 return "NO_WARNING";
67             case WARNING:
68                 return "WARNING";
69             default:
70                 return "0x" + Integer.toHexString(forwardCollisionWarningState);
71         }
72     }
73 
74     /** @hide */
75     @IntDef({OTHER, NO_WARNING, WARNING})
76     @Retention(RetentionPolicy.SOURCE)
77     public @interface ForwardCollisionWarningStateInt {}
78 }
79 
80