cn.nukkit.utils.Validation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of powernukkitx Show documentation
Make Nukkit great again!
There is a newer version: 1.20.40-r1
/*
 * https://PowerNukkit.org - The Nukkit you know but Powerful!
 * Copyright (C) 2020  José Roberto de Araújo Júnior
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package cn.nukkit.utils;

import cn.nukkit.api.PowerNukkitOnly;
import cn.nukkit.api.Since;
import lombok.experimental.UtilityClass;

import javax.annotation.Nullable;
import java.math.BigDecimal;
import java.math.BigInteger;

/**
 * @author joserobjr
 * @since 2020-10-11
 */
@PowerNukkitOnly
@Since("1.4.0.0-PN")
@UtilityClass
public class Validation {
    /**
     * Throws an exception if the value is negative.
     *
     * @param arg   The name of the argument, will be placed in front of the exception message if the value is is not null.
     * @param value The argument value to be validated.
     * @throws IllegalArgumentException If the value is negative.
     */
    @PowerNukkitOnly
    @Since("1.4.0.0-PN")
    public static void checkPositive(@Nullable String arg, byte value) {
        if (value < 0) {
            throw new IllegalArgumentException((arg != null ? arg + ": " : "") + "Negative value is not allowed: " + value);
        }
    }

    /**
     * Throws an exception if the value is negative.
     *
     * @param arg   The name of the argument, will be placed in front of the exception message if the value is is not null.
     * @param value The argument value to be validated.
     * @throws IllegalArgumentException If the value is negative.
     */
    @PowerNukkitOnly
    @Since("1.4.0.0-PN")
    public static void checkPositive(@Nullable String arg, short value) {
        if (value < 0) {
            throw new IllegalArgumentException((arg != null ? arg + ": " : "") + "Negative value is not allowed: " + value);
        }
    }

    /**
     * Throws an exception if the value is negative.
     *
     * @param arg   The name of the argument, will be placed in front of the exception message if the value is is not null.
     * @param value The argument value to be validated.
     * @throws IllegalArgumentException If the value is negative.
     */
    @PowerNukkitOnly
    @Since("1.4.0.0-PN")
    public static void checkPositive(@Nullable String arg, int value) {
        if (value < 0) {
            throw new IllegalArgumentException((arg != null ? arg + ": " : "") + "Negative value is not allowed: " + value);
        }
    }

    /**
     * Throws an exception if the value is negative.
     *
     * @param arg   The name of the argument, will be placed in front of the exception message if the value is is not null.
     * @param value The argument value to be validated.
     * @throws IllegalArgumentException If the value is negative.
     */
    @PowerNukkitOnly
    @Since("1.4.0.0-PN")
    public static void checkPositive(@Nullable String arg, long value) {
        if (value < 0) {
            throw new IllegalArgumentException((arg != null ? arg + ": " : "") + "Negative value is not allowed: " + value);
        }
    }

    /**
     * Throws an exception if the value is negative.
     *
     * @param arg   The name of the argument, will be placed in front of the exception message if the value is is not null.
     * @param value The argument value to be validated.
     * @throws IllegalArgumentException If the value is negative.
     */
    @PowerNukkitOnly
    @Since("1.4.0.0-PN")
    public static void checkPositive(@Nullable String arg, float value) {
        if (value < 0) {
            throw new IllegalArgumentException((arg != null ? arg + ": " : "") + "Negative value is not allowed: " + value);
        }
    }

    /**
     * Throws an exception if the value is negative.
     *
     * @param arg   The name of the argument, will be placed in front of the exception message if the value is is not null.
     * @param value The argument value to be validated.
     * @throws IllegalArgumentException If the value is negative.
     */
    @PowerNukkitOnly
    @Since("1.4.0.0-PN")
    public static void checkPositive(@Nullable String arg, double value) {
        if (value < 0) {
            throw new IllegalArgumentException((arg != null ? arg + ": " : "") + "Negative value is not allowed: " + value);
        }
    }

    /**
     * Throws an exception if the value is negative.
     *
     * @param arg   The name of the argument, will be placed in front of the exception message if the value is is not null.
     * @param value The argument value to be validated.
     * @throws IllegalArgumentException If the value is negative.
     */
    @PowerNukkitOnly
    @Since("1.4.0.0-PN")
    public static void checkPositive(@Nullable String arg, BigInteger value) {
        if (value.compareTo(BigInteger.ZERO) < 0) {
            throw new IllegalArgumentException((arg != null ? arg + ": " : "") + "Negative value is not allowed: " + value);
        }
    }

    /**
     * Throws an exception if the value is negative.
     *
     * @param arg   The name of the argument, will be placed in front of the exception message if the value is is not null.
     * @param value The argument value to be validated.
     * @throws IllegalArgumentException If the value is negative.
     */
    @PowerNukkitOnly
    @Since("1.4.0.0-PN")
    public static void checkPositive(@Nullable String arg, BigDecimal value) {
        if (value.compareTo(BigDecimal.ZERO) < 0) {
            throw new IllegalArgumentException((arg != null ? arg + ": " : "") + "Negative value is not allowed: " + value);
        }
    }
}