Package dev.prozilla.pine.common.util

Class Numbers

java.lang.Object

dev.prozilla.pine.common.util.Numbers

public final class Numbers
extends Object

Static utility methods for checking certain conditions before operation on numbers.

Constructor Summary

Constructors

Constructor	Description
Numbers()

Method Summary

Modifier and Type	Method	Description
static float	requirePositive(float number)	Checks that the given number is a positive number and throws an InvalidNumberException if it is not.
static float	requirePositive(float number, String message)	Checks that the given number is a positive number and throws a customized InvalidNumberException if it is not.
static int	requirePositive(int number)	Checks that the given number is a positive number and throws an InvalidNumberException if it is not.
static int	requirePositive(int number, String message)	Checks that the given number is a positive number and throws a customized InvalidNumberException if it is not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Numbers

public Numbers()

Method Details

requirePositive

public static float requirePositive(float number)
                             throws InvalidNumberException

Checks that the given number is a positive number and throws an InvalidNumberException if it is not.

Parameters:

number - The number to check

Returns:

number if it is positive.

Throws:

InvalidNumberException - If number is not positive.

requirePositive

public static float requirePositive(float number,
 String message)
                             throws InvalidNumberException

Checks that the given number is a positive number and throws a customized InvalidNumberException if it is not.

Parameters:

number - The number to check

message - The message to be used in the event that an InvalidNumberException is thrown

Returns:

number if it is positive.

Throws:

InvalidNumberException - If number is not positive.

requirePositive

public static int requirePositive(int number)
                           throws InvalidNumberException

Checks that the given number is a positive number and throws an InvalidNumberException if it is not.

Parameters:

number - The number to check

Returns:

number if it is positive.

Throws:

InvalidNumberException - If number is not positive.

requirePositive

public static int requirePositive(int number,
 String message)
                           throws InvalidNumberException

Checks that the given number is a positive number and throws a customized InvalidNumberException if it is not.

Parameters:

number - The number to check

message - The message to be used in the event that an InvalidNumberException is thrown

Returns:

number if it is positive.

Throws:

InvalidNumberException - If number is not positive.