1 /*
2  * Copyright (C) 2016 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 package android.car.cluster.renderer;
17 
18 import static com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport.BOILERPLATE_CODE;
19 
20 import android.annotation.Nullable;
21 import android.annotation.SystemApi;
22 import android.annotation.UiThread;
23 import android.car.navigation.CarNavigationInstrumentCluster;
24 import android.os.Bundle;
25 
26 import com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport;
27 
28 /**
29  * Contains methods specified for Navigation App renderer in instrument cluster.
30  *
31  * @hide
32  */
33 @SystemApi
34 @UiThread
35 @ExcludeFromCodeCoverageGeneratedReport(reason = BOILERPLATE_CODE)
36 public abstract class NavigationRenderer {
37     /**
38      * Returns properties of instrument cluster for navigation.
39      */
getNavigationProperties()40     public abstract CarNavigationInstrumentCluster getNavigationProperties();
41 
42     /**
43      * Called when a navigation state change is received.
44      *
45      * @removed Replaced by {@link #onNavigationStateChanged(Bundle)}
46      */
onEvent(int eventType, Bundle bundle)47     public void onEvent(int eventType, Bundle bundle) {
48     }
49 
50     /**
51      * Called when a navigation state change is received.
52      *
53      * @param bundle {@link android.os.Bundle} containing the description of the navigation state
54      *               change as an array of bytes. This information can be parsed using
55      *               {@link android.car.cluster.navigation.NavigationState.NavigationStateProto
56      *                                        #parseFrom(protoBytes)}.
57      */
onNavigationStateChanged(@ullable Bundle bundle)58     public void onNavigationStateChanged(@Nullable Bundle bundle) {
59     }
60 }
61