xref: /packages/services/Car/car-lib/src/android/car/hardware/property/CarPropertyEvent.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.hardware.property;

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

import android.annotation.NonNull;
import android.car.annotation.AddedInOrBefore;
import android.car.hardware.CarPropertyValue;
import android.os.Parcel;
import android.os.Parcelable;

import com.android.car.internal.ExcludeFromCodeCoverageGeneratedReport;

import java.util.Objects;

/** @hide */
public class CarPropertyEvent implements Parcelable {
    @AddedInOrBefore(majorVersion = 33)
    public static final int PROPERTY_EVENT_PROPERTY_CHANGE = 0;
    @AddedInOrBefore(majorVersion = 33)
    public static final int PROPERTY_EVENT_ERROR = 1;
    /**
     * EventType of this message
     */
    private final int mEventType;

    /**
     * ErrorCode of this message.
     */
    private final @CarPropertyManager.CarSetPropertyErrorCode int mErrorCode;
    private final CarPropertyValue<?> mCarPropertyValue;

    // Use it as default value for error events.
    private static final int ERROR_EVENT_VALUE = -1;

    /**
     * @return EventType field
     */
    @AddedInOrBefore(majorVersion = 33)
    public int getEventType() {
        return mEventType;
    }

    /**
     * Returns {@link CarPropertyValue} associated with this event.
     */
    @AddedInOrBefore(majorVersion = 33)
    public CarPropertyValue<?> getCarPropertyValue() {
        return mCarPropertyValue;
    }

    @Override
    @ExcludeFromCodeCoverageGeneratedReport(reason = BOILERPLATE_CODE)
    @AddedInOrBefore(majorVersion = 33)
    public int describeContents() {
        return 0;
    }

    @Override
    @AddedInOrBefore(majorVersion = 33)
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeInt(mEventType);
        dest.writeInt(mErrorCode);
        dest.writeParcelable(mCarPropertyValue, flags);
    }

    @AddedInOrBefore(majorVersion = 33)
    public static final Parcelable.Creator<CarPropertyEvent> CREATOR =
            new Parcelable.Creator<CarPropertyEvent>() {

        @Override
        public CarPropertyEvent createFromParcel(Parcel in) {
            return new CarPropertyEvent(in);
        }

        @Override
        public CarPropertyEvent[] newArray(int size) {
            return new CarPropertyEvent[size];
        }
        };

    /**
     * Constructor for {@link CarPropertyEvent}.
     */
    public CarPropertyEvent(int eventType, @NonNull CarPropertyValue<?> carPropertyValue) {
        mEventType  = eventType;
        mErrorCode = CarPropertyManager.CAR_SET_PROPERTY_ERROR_CODE_UNKNOWN;
        mCarPropertyValue = carPropertyValue;
    }

    /**
     * Constructor for {@link CarPropertyEvent} with an error code.
     */
    public CarPropertyEvent(int eventType, @NonNull CarPropertyValue<?> carPropertyValue,
            @CarPropertyManager.CarSetPropertyErrorCode int errorCode) {
        mEventType  = eventType;
        mErrorCode = errorCode;
        mCarPropertyValue = carPropertyValue;
    }


    /**
     * Constructor for {@link CarPropertyEvent} when it is an error event.
     *
     * The {@link CarPropertyValue} in the event is only used to pass property ID and area ID to
     * {@link CarPropertyManager}. In {@link CarPropertyManager}, the value of
     * {@link CarPropertyValue} will be dropped.
     */
    @AddedInOrBefore(majorVersion = 33)
    public static CarPropertyEvent createErrorEventWithErrorCode(int propertyId, int areaId,
            @CarPropertyManager.CarSetPropertyErrorCode int errorCode) {
        // We don't care about about timestamp and value here. We are only using the
        // CarPropertyValue to pass propertyId and areaId.
        CarPropertyValue<Integer> valueWithErrorCode = new CarPropertyValue<>(propertyId, areaId,
                /* timestampNanos= */ 0, ERROR_EVENT_VALUE);
        CarPropertyEvent event = new CarPropertyEvent(PROPERTY_EVENT_ERROR, valueWithErrorCode,
                errorCode);
        return event;
    }

    @AddedInOrBefore(majorVersion = 33)
    public @CarPropertyManager.CarSetPropertyErrorCode int getErrorCode() {
        return mErrorCode;
    }

    private CarPropertyEvent(Parcel in) {
        mEventType  = in.readInt();
        mErrorCode = in.readInt();
        mCarPropertyValue = in.readParcelable(CarPropertyValue.class.getClassLoader());
    }

    @Override
    public String toString() {
        return "CarPropertyEvent{"
                + "mEventType=" + mEventType
                + ", mErrorCode=" + mErrorCode
                + ", mCarPropertyValue=" + mCarPropertyValue
                + '}';
    }

    /** Checks equality with passed {@code object}. */
    @Override
    public boolean equals(Object object) {
        if (this == object) {
            return true;
        }
        if (!(object instanceof CarPropertyEvent)) {
            return false;
        }
        CarPropertyEvent carPropertyEvent = (CarPropertyEvent) object;
        return mEventType == carPropertyEvent.mEventType
                && mErrorCode == carPropertyEvent.mErrorCode && mCarPropertyValue.equals(
                carPropertyEvent.mCarPropertyValue);
    }

    /** Generates hash code for this instance. */
    @Override
    public int hashCode() {
        return Objects.hash(mEventType, mErrorCode, mCarPropertyValue);
    }
}