CarInternalError.java
/*
* Copyright 2021 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 androidx.car.app.hardware.common;
import static androidx.annotation.RestrictTo.Scope.LIBRARY;
import android.car.hardware.CarPropertyValue;
import androidx.annotation.NonNull;
import androidx.annotation.RestrictTo;
import com.google.auto.value.AutoValue;
/**
* Container class for information about the error detected in the car.
*
* <p>The {@link PropertyRequestProcessor} uses it to indicate there is an exception or error in
* {@link android.car.hardware.property.CarPropertyManager}. It should not be exposed to front-end
* such as {@link androidx.car.app.hardware.info.AutomotiveCarInfo}.
*
* @hide
*/
@AutoValue
@RestrictTo(LIBRARY)
abstract class CarInternalError {
/**
* @param propertyId one of the values in {@link android.car.VehiclePropertyIds}
* @param areaId the same value used in {@link CarPropertyValue#getAreaId()}
* @param errorCode one of the values in {@link CarValue.StatusCode}
*/
@NonNull
static CarInternalError create(int propertyId, int areaId,
@CarValue.StatusCode int errorCode) {
return new AutoValue_CarInternalError(propertyId, areaId, errorCode);
}
/** Returns one of the values in {@link android.car.VehiclePropertyIds}. */
abstract int getPropertyId();
/** Returns the same value used in {@link CarPropertyValue#getAreaId()}. */
abstract int getAreaId();
/** Returns one of the values in {@link CarValue.StatusCode}. */
abstract @CarValue.StatusCode int getErrorCode();
}