com.github.prominence.openweathermap.api.enums.UnitSystem Maven / Gradle / Ivy

/*
 * Copyright (c) 2021 Alexey Zinchenko
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.github.prominence.openweathermap.api.enums;

/**
 * An enumeration for supported unit systems with helper methods.
 */
public enum UnitSystem {
    /**
     * Metric units: Celsius, meter/sec, hPa, mm(rain, snow).
     */
    METRIC("metric"),

    /**
     * Imperial units: Fahrenheit, miles/hour, hPa, mm(rain, snow).
     */
    IMPERIAL("imperial"),

    /**
     * OpenWeatherMap standard units: Kelvin, meter/sec, hPa, mm(rain, snow).
     */
    STANDARD("standard");

    private final String value;

    UnitSystem(String value) {
        this.value = value;
    }

    /**
     * Returns wind unit for current unit system.
     * @return wind unit.
     */
    public String getWindUnit() {
        switch (this) {
            case IMPERIAL:
                return "miles/hour";
            case STANDARD:
            case METRIC:
            default:
                return "meter/sec";
        }
    }

    /**
     * Returns temperature unit for current unit system.
     * @return temperature unit.
     */
    public String getTemperatureUnit() {
        switch (this) {
            case METRIC:
                return "°C";
            case IMPERIAL:
                return "°F";
            case STANDARD:
            default:
                return "K";
        }
    }

    /**
     * Returns unit system value.
     * @return value unit system.
     */
    public String getValue() {
        return value;
    }
}