Argument (Avail 1.0.0 API)

java.lang.Object
- com.frostphyr.avail.Argument

```
public final class Argument
extends Object
```
Utility class containing methods to check for valid argument conditions.

Since:

1.0

Method Summary

Methods
Modifier and Type	Method and Description
`static byte`	`checkGreaterThan(byte value, byte number)` Returns the specified `value` if it is greater than the specified `number`, otherwise throws `IllegalArgumentException`.
`static char`	`checkGreaterThan(char value, char number)` Returns the specified `value` if it is greater than the specified `number`, otherwise throws `IllegalArgumentException`.
`static double`	`checkGreaterThan(double value, double number)` Returns the specified `value` if it is greater than the specified `number`, otherwise throws `IllegalArgumentException`.
`static float`	`checkGreaterThan(float value, float number)` Returns the specified `value` if it is greater than the specified `number`, otherwise throws `IllegalArgumentException`.
`static int`	`checkGreaterThan(int value, int number)` Returns the specified `value` if it is greater than the specified `number`, otherwise throws `IllegalArgumentException`.
`static long`	`checkGreaterThan(long value, long number)` Returns the specified `value` if it is greater than the specified `number`, otherwise throws `IllegalArgumentException`.
`static short`	`checkGreaterThan(short value, short number)` Returns the specified `value` if it is greater than the specified `number`, otherwise throws `IllegalArgumentException`.
`static byte`	`checkGreaterThanOrEqual(byte value, byte number)` Returns the specified `value` if it is greater than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static char`	`checkGreaterThanOrEqual(char value, char number)` Returns the specified `value` if it is greater than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static double`	`checkGreaterThanOrEqual(double value, double number)` Returns the specified `value` if it is greater than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static float`	`checkGreaterThanOrEqual(float value, float number)` Returns the specified `value` if it is greater than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static int`	`checkGreaterThanOrEqual(int value, int number)` Returns the specified `value` if it is greater than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static long`	`checkGreaterThanOrEqual(long value, long number)` Returns the specified `value` if it is greater than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static short`	`checkGreaterThanOrEqual(short value, short number)` Returns the specified `value` if it is greater than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static byte`	`checkInsideRange(byte value, byte min, byte max)` Returns the specified `value` if it is inside the specified range, which means greater than or equal to `min` and less than or equal to `max`.
`static char`	`checkInsideRange(char value, char min, char max)` Returns the specified `value` if it is inside the specified range, which means greater than or equal to `min` and less than or equal to `max`.
`static double`	`checkInsideRange(double value, double min, double max)` Returns the specified `value` if it is inside the specified range, which means greater than or equal to `min` and less than or equal to `max`.
`static float`	`checkInsideRange(float value, float min, float max)` Returns the specified `value` if it is inside the specified range, which means greater than or equal to `min` and less than or equal to `max`.
`static int`	`checkInsideRange(int value, int min, int max)` Returns the specified `value` if it is inside the specified range, which means greater than or equal to `min` and less than or equal to `max`.
`static long`	`checkInsideRange(long value, long min, long max)` Returns the specified `value` if it is inside the specified range, which means greater than or equal to `min` and less than or equal to `max`.
`static short`	`checkInsideRange(short value, short min, short max)` Returns the specified `value` if it is inside the specified range, which means greater than or equal to `min` and less than or equal to `max`.
`static byte`	`checkLessThan(byte value, byte number)` Returns the specified `value` if it is less than the specified `number`, otherwise throws `IllegalArgumentException`.
`static char`	`checkLessThan(char value, char number)` Returns the specified `value` if it is less than the specified `number`, otherwise throws `IllegalArgumentException`.
`static double`	`checkLessThan(double value, double number)` Returns the specified `value` if it is less than the specified `number`, otherwise throws `IllegalArgumentException`.
`static float`	`checkLessThan(float value, float number)` Returns the specified `value` if it is less than the specified `number`, otherwise throws `IllegalArgumentException`.
`static int`	`checkLessThan(int value, int number)` Returns the specified `value` if it is less than the specified `number`, otherwise throws `IllegalArgumentException`.
`static long`	`checkLessThan(long value, long number)` Returns the specified `value` if it is less than the specified `number`, otherwise throws `IllegalArgumentException`.
`static short`	`checkLessThan(short value, short number)` Returns the specified `value` if it is less than the specified `number`, otherwise throws `IllegalArgumentException`.
`static byte`	`checkLessThanOrEqual(byte value, byte number)` Returns the specified `value` if it is less than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static char`	`checkLessThanOrEqual(char value, char number)` Returns the specified `value` if it is less than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static double`	`checkLessThanOrEqual(double value, double number)` Returns the specified `value` if it is less than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static float`	`checkLessThanOrEqual(float value, float number)` Returns the specified `value` if it is less than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static int`	`checkLessThanOrEqual(int value, int number)` Returns the specified `value` if it is less than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static long`	`checkLessThanOrEqual(long value, long number)` Returns the specified `value` if it is less than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static short`	`checkLessThanOrEqual(short value, short number)` Returns the specified `value` if it is less than or equal to the specified `number`, otherwise throws `IllegalArgumentException`.
`static byte`	`checkNegative(byte value)` Returns the specified `value` if it is negative, which means less than 0.
`static double`	`checkNegative(double value)` Returns the specified `value` if it is negative, which means less than 0.
`static float`	`checkNegative(float value)` Returns the specified `value` if it is negative, which means less than 0.
`static int`	`checkNegative(int value)` Returns the specified `value` if it is negative, which means less than 0.
`static long`	`checkNegative(long value)` Returns the specified `value` if it is negative, which means less than 0.
`static short`	`checkNegative(short value)` Returns the specified `value` if it is negative, which means less than 0.
`static <T> T`	`checkNotNull(T value)` Returns the specified `value` if it is not `null`, otherwise throws `IllegalArgumentException`.
`static byte`	`checkPercent(byte value)` Returns the specified `value` if it is a valid percent, which means between 0 and 100.
`static double`	`checkPercent(double value)` Returns the specified `value` if it is a valid percent, which means between 0 and 100.
`static float`	`checkPercent(float value)` Returns the specified `value` if it is a valid percent, which means between 0 and 100.
`static int`	`checkPercent(int value)` Returns the specified `value` if it is a valid percent, which means between 0 and 100.
`static long`	`checkPercent(long value)` Returns the specified `value` if it is a valid percent, which means between 0 and 100.
`static short`	`checkPercent(short value)` Returns the specified `value` if it is a valid percent, which means between 0 and 100.
`static byte`	`checkPositive(byte value)` Returns the specified `value` if it is positive, which means greater than or equal to 0.
`static double`	`checkPositive(double value)` Returns the specified `value` if it is positive, which means greater than or equal to 0.
`static float`	`checkPositive(float value)` Returns the specified `value` if it is positive, which means greater than or equal to 0.
`static int`	`checkPositive(int value)` Returns the specified `value` if it is positive, which means greater than or equal to 0.
`static long`	`checkPositive(long value)` Returns the specified `value` if it is positive, which means greater than or equal to 0.
`static short`	`checkPositive(short value)` Returns the specified `value` if it is positive, which means greater than or equal to 0.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - checkNotNull
```
public static <T> T checkNotNull(T value)
```
    Returns the specified value if it is not null, otherwise throws IllegalArgumentException.
    
    Type Parameters:
    T - the type of the value
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkGreaterThan
```
public static byte checkGreaterThan(byte value,
                    byte number)
```
    Returns the specified value if it is greater than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than
    
    Returns:
    the same value
  - checkGreaterThan
```
public static short checkGreaterThan(short value,
                     short number)
```
    Returns the specified value if it is greater than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than
    
    Returns:
    the same value
  - checkGreaterThan
```
public static int checkGreaterThan(int value,
                   int number)
```
    Returns the specified value if it is greater than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than
    
    Returns:
    the same value
  - checkGreaterThan
```
public static long checkGreaterThan(long value,
                    long number)
```
    Returns the specified value if it is greater than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than
    
    Returns:
    the same value
  - checkGreaterThan
```
public static float checkGreaterThan(float value,
                     float number)
```
    Returns the specified value if it is greater than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than
    
    Returns:
    the same value
  - checkGreaterThan
```
public static double checkGreaterThan(double value,
                      double number)
```
    Returns the specified value if it is greater than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than
    
    Returns:
    the same value
  - checkGreaterThan
```
public static char checkGreaterThan(char value,
                    char number)
```
    Returns the specified value if it is greater than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than
    
    Returns:
    the same value
  - checkGreaterThanOrEqual
```
public static byte checkGreaterThanOrEqual(byte value,
                           byte number)
```
    Returns the specified value if it is greater than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than or equal to
    
    Returns:
    the same value
  - checkGreaterThanOrEqual
```
public static short checkGreaterThanOrEqual(short value,
                            short number)
```
    Returns the specified value if it is greater than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than or equal to
    
    Returns:
    the same value
  - checkGreaterThanOrEqual
```
public static int checkGreaterThanOrEqual(int value,
                          int number)
```
    Returns the specified value if it is greater than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than or equal to
    
    Returns:
    the same value
  - checkGreaterThanOrEqual
```
public static long checkGreaterThanOrEqual(long value,
                           long number)
```
    Returns the specified value if it is greater than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than or equal to
    
    Returns:
    the same value
  - checkGreaterThanOrEqual
```
public static float checkGreaterThanOrEqual(float value,
                            float number)
```
    Returns the specified value if it is greater than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than or equal to
    
    Returns:
    the same value
  - checkGreaterThanOrEqual
```
public static double checkGreaterThanOrEqual(double value,
                             double number)
```
    Returns the specified value if it is greater than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than or equal to
    
    Returns:
    the same value
  - checkGreaterThanOrEqual
```
public static char checkGreaterThanOrEqual(char value,
                           char number)
```
    Returns the specified value if it is greater than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be greater than or equal to
    
    Returns:
    the same value
  - checkLessThan
```
public static byte checkLessThan(byte value,
                 byte number)
```
    Returns the specified value if it is less than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than
    
    Returns:
    the same value
  - checkLessThan
```
public static short checkLessThan(short value,
                  short number)
```
    Returns the specified value if it is less than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than
    
    Returns:
    the same value
  - checkLessThan
```
public static int checkLessThan(int value,
                int number)
```
    Returns the specified value if it is less than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than
    
    Returns:
    the same value
  - checkLessThan
```
public static long checkLessThan(long value,
                 long number)
```
    Returns the specified value if it is less than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than
    
    Returns:
    the same value
  - checkLessThan
```
public static float checkLessThan(float value,
                  float number)
```
    Returns the specified value if it is less than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than
    
    Returns:
    the same value
  - checkLessThan
```
public static double checkLessThan(double value,
                   double number)
```
    Returns the specified value if it is less than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than
    
    Returns:
    the same value
  - checkLessThan
```
public static char checkLessThan(char value,
                 char number)
```
    Returns the specified value if it is less than the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than
    
    Returns:
    the same value
  - checkLessThanOrEqual
```
public static byte checkLessThanOrEqual(byte value,
                        byte number)
```
    Returns the specified value if it is less than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than or equal to
    
    Returns:
    the same value
  - checkLessThanOrEqual
```
public static short checkLessThanOrEqual(short value,
                         short number)
```
    Returns the specified value if it is less than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than or equal to
    
    Returns:
    the same value
  - checkLessThanOrEqual
```
public static int checkLessThanOrEqual(int value,
                       int number)
```
    Returns the specified value if it is less than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than or equal to
    
    Returns:
    the same value
  - checkLessThanOrEqual
```
public static long checkLessThanOrEqual(long value,
                        long number)
```
    Returns the specified value if it is less than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than or equal to
    
    Returns:
    the same value
  - checkLessThanOrEqual
```
public static float checkLessThanOrEqual(float value,
                         float number)
```
    Returns the specified value if it is less than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than or equal to
    
    Returns:
    the same value
  - checkLessThanOrEqual
```
public static double checkLessThanOrEqual(double value,
                          double number)
```
    Returns the specified value if it is less than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than or equal to
    
    Returns:
    the same value
  - checkLessThanOrEqual
```
public static char checkLessThanOrEqual(char value,
                        char number)
```
    Returns the specified value if it is less than or equal to the specified number, otherwise throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    number - the number that value must be less than or equal to
    
    Returns:
    the same value
  - checkPositive
```
public static byte checkPositive(byte value)
```
    Returns the specified value if it is positive, which means greater than or equal to 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPositive
```
public static short checkPositive(short value)
```
    Returns the specified value if it is positive, which means greater than or equal to 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPositive
```
public static int checkPositive(int value)
```
    Returns the specified value if it is positive, which means greater than or equal to 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPositive
```
public static long checkPositive(long value)
```
    Returns the specified value if it is positive, which means greater than or equal to 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPositive
```
public static float checkPositive(float value)
```
    Returns the specified value if it is positive, which means greater than or equal to 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPositive
```
public static double checkPositive(double value)
```
    Returns the specified value if it is positive, which means greater than or equal to 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkNegative
```
public static byte checkNegative(byte value)
```
    Returns the specified value if it is negative, which means less than 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkNegative
```
public static short checkNegative(short value)
```
    Returns the specified value if it is negative, which means less than 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkNegative
```
public static int checkNegative(int value)
```
    Returns the specified value if it is negative, which means less than 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkNegative
```
public static long checkNegative(long value)
```
    Returns the specified value if it is negative, which means less than 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkNegative
```
public static float checkNegative(float value)
```
    Returns the specified value if it is negative, which means less than 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkNegative
```
public static double checkNegative(double value)
```
    Returns the specified value if it is negative, which means less than 0. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkInsideRange
```
public static byte checkInsideRange(byte value,
                    byte min,
                    byte max)
```
    Returns the specified value if it is inside the specified range, which means greater than or equal to min and less than or equal to max. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    min - the minimum that value can be
    max - the maximum that value can be
    
    Returns:
    the same value
  - checkInsideRange
```
public static short checkInsideRange(short value,
                     short min,
                     short max)
```
    Returns the specified value if it is inside the specified range, which means greater than or equal to min and less than or equal to max. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    min - the minimum that value can be
    max - the maximum that value can be
    
    Returns:
    the same value
  - checkInsideRange
```
public static int checkInsideRange(int value,
                   int min,
                   int max)
```
    Returns the specified value if it is inside the specified range, which means greater than or equal to min and less than or equal to max. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    min - the minimum that value can be
    max - the maximum that value can be
    
    Returns:
    the same value
  - checkInsideRange
```
public static long checkInsideRange(long value,
                    long min,
                    long max)
```
    Returns the specified value if it is inside the specified range, which means greater than or equal to min and less than or equal to max. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    min - the minimum that value can be
    max - the maximum that value can be
    
    Returns:
    the same value
  - checkInsideRange
```
public static float checkInsideRange(float value,
                     float min,
                     float max)
```
    Returns the specified value if it is inside the specified range, which means greater than or equal to min and less than or equal to max. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    min - the minimum that value can be
    max - the maximum that value can be
    
    Returns:
    the same value
  - checkInsideRange
```
public static double checkInsideRange(double value,
                      double min,
                      double max)
```
    Returns the specified value if it is inside the specified range, which means greater than or equal to min and less than or equal to max. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    min - the minimum that value can be
    max - the maximum that value can be
    
    Returns:
    the same value
  - checkInsideRange
```
public static char checkInsideRange(char value,
                    char min,
                    char max)
```
    Returns the specified value if it is inside the specified range, which means greater than or equal to min and less than or equal to max. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    min - the minimum that value can be
    max - the maximum that value can be
    
    Returns:
    the same value
  - checkPercent
```
public static byte checkPercent(byte value)
```
    Returns the specified value if it is a valid percent, which means between 0 and 100. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPercent
```
public static short checkPercent(short value)
```
    Returns the specified value if it is a valid percent, which means between 0 and 100. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPercent
```
public static int checkPercent(int value)
```
    Returns the specified value if it is a valid percent, which means between 0 and 100. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPercent
```
public static long checkPercent(long value)
```
    Returns the specified value if it is a valid percent, which means between 0 and 100. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPercent
```
public static float checkPercent(float value)
```
    Returns the specified value if it is a valid percent, which means between 0 and 100. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value
  - checkPercent
```
public static double checkPercent(double value)
```
    Returns the specified value if it is a valid percent, which means between 0 and 100. If not, throws IllegalArgumentException.
    
    Parameters:
    value - the value to check
    
    Returns:
    the same value

Class Argument

Method Summary

Methods inherited from class java.lang.Object

Method Detail

checkNotNull

checkGreaterThan

checkGreaterThan

checkGreaterThan

checkGreaterThan

checkGreaterThan

checkGreaterThan

checkGreaterThan

checkGreaterThanOrEqual

checkGreaterThanOrEqual

checkGreaterThanOrEqual

checkGreaterThanOrEqual

checkGreaterThanOrEqual

checkGreaterThanOrEqual

checkGreaterThanOrEqual

checkLessThan

checkLessThan

checkLessThan

checkLessThan

checkLessThan

checkLessThan

checkLessThan

checkLessThanOrEqual

checkLessThanOrEqual

checkLessThanOrEqual

checkLessThanOrEqual

checkLessThanOrEqual

checkLessThanOrEqual

checkLessThanOrEqual

checkPositive

checkPositive

checkPositive

checkPositive

checkPositive

checkPositive

checkNegative

checkNegative

checkNegative

checkNegative

checkNegative

checkNegative

checkInsideRange

checkInsideRange

checkInsideRange

checkInsideRange

checkInsideRange

checkInsideRange

checkInsideRange

checkPercent

checkPercent

checkPercent

checkPercent

checkPercent

checkPercent