SeatTemperatureProfile.java

/*
         * Copyright 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 androidx.car.app.hardware.climate;

import android.util.Pair;

import androidx.annotation.NonNull;
import androidx.car.app.annotations.ExperimentalCarApi;
import androidx.car.app.hardware.common.CarZone;

import java.util.Collections;
import java.util.Map;
import java.util.Set;

/**
 * Container class for information about the {@link
 * ClimateProfileRequest#FEATURE_SEAT_TEMPERATURE_LEVEL} feature such as supported min/max range
 * values for the feature.
 */
@ExperimentalCarApi
public final class SeatTemperatureProfile {

    @NonNull
    private final Map<Set<CarZone>, Pair<Integer, Integer>> mCarZoneSetsToSeatTemperatureValues;

    /**
     * Returns a list of supported min/max range values for the feature mapped to the set of car
     * zones.
     *
     * <p>The values that can be regulated together for a set of car zones are combined together.
     */
    @NonNull
    public Map<Set<CarZone>, Pair<Integer, Integer>> getCarZoneSetsToSeatTemperatureValues() {
        return mCarZoneSetsToSeatTemperatureValues;
    }

    SeatTemperatureProfile(SeatTemperatureProfile.Builder builder) {
        mCarZoneSetsToSeatTemperatureValues = Collections.unmodifiableMap(
                builder.mCarZoneSetsToSeatTemperatureValues);
    }

    /** A builder for SeatTemperatureProfile. */
    public static final class Builder {
        Map<Set<CarZone>, Pair<Integer, Integer>> mCarZoneSetsToSeatTemperatureValues;

        /**
         * Creates an instance of builder.
         *
         * @param carZoneSetsToSeatTemperatureValues   map of min/max range values for the property
         *                                             corresponding to the set of car zones.
         *                                             Min/max range defines the allowable range
         *                                             and number of steps in each direction. The
         *                                             values are not in any specific units, they
         *                                             represent seat temperature setting instead.
         *                                             Negative values indicate cooling.
         *                                             0 indicates off.
         *                                             Positive values indicate heating.
         */
        public Builder(
                @NonNull Map<Set<CarZone>, Pair<Integer, Integer>>
                        carZoneSetsToSeatTemperatureValues) {
            mCarZoneSetsToSeatTemperatureValues = Collections.unmodifiableMap(
                    carZoneSetsToSeatTemperatureValues);
        }

        /** Create a SeatTemperatureProfile. */
        @NonNull
        public SeatTemperatureProfile build() {
            return new SeatTemperatureProfile(this);
        }
    }
}