com.github.mfathi91

Class MyUtils

java.lang.Object

com.github.mfathi91.MyUtils

@ThreadSafe
public class MyUtils
extends Object

This class provides static helper methods, in order to remove boilerplate code. It is not possible to get an instance of this class.

This class is stateless and thread-safe.

Method Summary

Modifier and Type	Method and Description
static int	intRequirePositive(int val, String valName) Checks whether an integer is greater than zero or not.
static int	intRequireRange(int val, int lowerLimit, int upperLimit, String valName) Checks whether an integer is in a range or not.
static boolean	isBetween(int val, int lowerLimit, int upperLimit) Returns true if and only if val is greater than or equal to lowerLimit and is less than or equal to upperLimit.

Methods inherited from class java.lang.Object

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

Method Detail

isBetween

public static boolean isBetween(int val,
                                int lowerLimit,
                                int upperLimit)

Returns true if and only if val is greater than or equal to lowerLimit and is less than or equal to upperLimit.

Parameters:

val - the value to be checked, an integer

lowerLimit - lower boundary to be checked, an integer

upperLimit - upper boundary to be checked, an integer

Returns:

true if and only if val is between lowerLimit and upperLimit

intRequireRange

public static int intRequireRange(int val,
                                  int lowerLimit,
                                  int upperLimit,
                                  String valName)

Checks whether an integer is in a range or not. If val is less than lowerLimit or greater than upperLimit, an IllegalArgumentException will be thrown with a suitable message.

Parameters:

val - value to check

lowerLimit - lower limit of range

upperLimit - upper limit of range

valName - the name of val that is printed in the exception message

Returns:

val, if it is in the range

intRequirePositive

public static int intRequirePositive(int val,
                                     String valName)

Checks whether an integer is greater than zero or not. If val is less than or equal to zero, an IllegalArgumentException will be thrown with a suitable message.

Parameters:

val - integer value to check

valName - name of val that is printed in the exception message

Returns:

val, if it is positive