com.github.prominence.openweathermap.api.model.Humidity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openweathermap-api Show documentation
Java API for OpenWeatherMap services.
There is a newer version: 2.4.0
/*
 * 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.model;

import java.util.Objects;

/**
 * The Humidity type represents humidity value percentage.
 * Its value can only be an integer in [0, 100] range.
 */
public class Humidity {
    private static final String DEFAULT_UNIT = "%";

    private int value;

    /**
     * Instantiates a new Humidity.
     *
     * @param value the value representing humidity percentage.
     * @throws IllegalArgumentException in case if provided value isn't in allowed range.
     */
    private Humidity(byte value) {
        this.value = value;
    }

    /**
     * Creates {@link Humidity} object with correctness check.
     * @param value humidity
     * @return created {@link Humidity} object
     */
    public static Humidity withValue(byte value) {
        if (value < 0 || value > 100)  {
            throw new IllegalArgumentException("Humidity value must be in [0, 100] range.");
        }
        return new Humidity(value);
    }

    /**
     * Returns humidity percentage value.
     *
     * @return humidity percentage.
     */
    public int getValue() {
        return value;
    }

    /**
     * Sets humidity percentage value.
     *
     * @param value new humidity value.
     * @throws IllegalArgumentException in case if provided value isn't in allowed range.
     */
    public void setValue(int value) {
        if (value < 0 || value > 100)  {
            throw new IllegalArgumentException("Humidity value must be in [0, 100] range.");
        }
        this.value = value;
    }

    /**
     * Returns humidity unitSystem. Constantly equals to '%'.
     *
     * @return the humidity unitSystem.
     */
    public String getUnit() {
        return DEFAULT_UNIT;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof Humidity)) return false;
        Humidity humidity = (Humidity) o;
        return value == humidity.value;
    }

    @Override
    public int hashCode() {
        return Objects.hash(value);
    }

    @Override
    public String toString() {
        return "Humidity: " + value + getUnit();
    }
}