/*
 * 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_STEERING_WHEEL_HEAT} feature such as supported min/max range
 * values for the feature.
 */
@ExperimentalCarApi
public final class SteeringWheelHeatProfile {

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

    /**
     * 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>> getCarZoneSetsToSteeringWheelHeatValues() {
        return mCarZoneSetsToSteeringWheelHeatValues;
    }

    SteeringWheelHeatProfile(Builder builder) {
        mCarZoneSetsToSteeringWheelHeatValues = Collections.unmodifiableMap(
                builder.mCarZoneSetsToSteeringWheelHeatValues);
    }

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

        /**
         * Creates an instance of builder.
         *
         * @param carZoneSetsToSteeringWheelHeatValues   map of min/max range values for the
         *                                               property corresponding to the set of car
         *                                               zones.
         *                                               Min/max values indicate heating or
         *                                               cooling for the steering wheel. The
         *                                               values are not in any specific units,
         *                                               they represent steering wheel heat setting
         *                                               modes instead.
         *                                               0 indicates temperature control is off.
         *                                               Negative value indicates cooling.
         *                                               Positive value indicates heating.
         */
        public Builder(
                @NonNull Map<Set<CarZone>, Pair<Integer, Integer>>
                        carZoneSetsToSteeringWheelHeatValues) {
            mCarZoneSetsToSteeringWheelHeatValues = Collections.unmodifiableMap(
                    carZoneSetsToSteeringWheelHeatValues);
        }

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