car-lib/src/android/car/GsrComplianceRequirementType.java

/*
 * Copyright (C) 2022 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;

import android.annotation.IntDef;
import android.car.annotation.ApiRequirements;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

/**
 * Used by
 * {@link VehicleProperty.GENERAL_SAFETY_REGULATION_COMPLIANCE_REQUIREMENT} to
 * indicate what kind of general safety regulation compliance requirement is
 * enforced.
 */
public final class GsrComplianceRequirementType {
    /**
     * GSR compliance is not required.
     */
    @ApiRequirements(minCarVersion = ApiRequirements.CarVersion.TIRAMISU_1,
             minPlatformVersion = ApiRequirements.PlatformVersion.TIRAMISU_0)
    public static final int GSR_COMPLIANCE_NOT_REQUIRED = 0;
    /**
     * GSR compliance is required and the requirement solution version is 1.
     */
    @ApiRequirements(minCarVersion = ApiRequirements.CarVersion.TIRAMISU_1,
             minPlatformVersion = ApiRequirements.PlatformVersion.TIRAMISU_0)
    public static final int GSR_COMPLIANCE_REQUIRED_V1 = 1;

    /** @hide */
    @IntDef({
        GSR_COMPLIANCE_NOT_REQUIRED,
        GSR_COMPLIANCE_REQUIRED_V1
    })
    @Retention(RetentionPolicy.SOURCE)
    public @interface Enum {}

    private GsrComplianceRequirementType() {}
}