car-lib/src/android/car/cluster/renderer/NavigationRenderer.java

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package android.car.cluster.renderer;

import static com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport.BOILERPLATE_CODE;

import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.annotation.UiThread;
import android.car.navigation.CarNavigationInstrumentCluster;
import android.os.Bundle;

import com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport;

/**
 * Contains methods specified for Navigation App renderer in instrument cluster.
 *
 * @hide
 */
@SystemApi
@UiThread
@ExcludeFromCodeCoverageGeneratedReport(reason = BOILERPLATE_CODE)
public abstract class NavigationRenderer {
    /**
     * Returns properties of instrument cluster for navigation.
     */
    public abstract CarNavigationInstrumentCluster getNavigationProperties();

    /**
     * Called when a navigation state change is received.
     *
     * @removed Replaced by {@link #onNavigationStateChanged(Bundle)}
     */
    public void onEvent(int eventType, Bundle bundle) {
    }

    /**
     * Called when a navigation state change is received.
     *
     * @param bundle {@link android.os.Bundle} containing the description of the navigation state
     *               change as an array of bytes. This information can be parsed using
     *               {@link android.car.cluster.navigation.NavigationState.NavigationStateProto
     *                                        #parseFrom(protoBytes)}.
     */
    public void onNavigationStateChanged(@Nullable Bundle bundle) {
    }
}