Package io.github.mrtesz.teszcore.util

Class Conditions

java.lang.Object

io.github.mrtesz.teszcore.util.Conditions

public class Conditions
extends Object

Constructor Summary

Constructors

Constructor	Description
Conditions()

Method Summary

Modifier and Type	Method	Description
static void	checkArgument(boolean argument)	Throw an error if the provided argument is `false`
static void	checkArgument(boolean argument, @Nullable String message)	Throw an error if the provided argument is `false`
static <T> T	checkNonNull(T obj)	Check if an object is not `null` and throw an exception if it is
static <T> T	checkNonNull(T obj, @Nullable String message)	Check if an object is not `null` and throw an exception if it is
static <T> void	checkNull(T obj)	Check if an object is `null` and throw an exception if it is
static <T> void	checkNull(T obj, @Nullable String message)	Check if an object is `null` and throw an exception if it is
static <T extends Number> T	checkRange(T num, T min, T max)	Check if a number is in a range and throw an exception if not
static <T extends Number> T	checkRange(T num, T min, T max, @Nullable String message)	Check if a number is in a range and throw an exception if not
static void	checkState(boolean state)	Check a `boolean` and throw an exception if it is `false`
static void	checkState(boolean state, @Nullable String message)	Check a `boolean` and throw an exception if it is `false`

Methods inherited from class java.lang.Object

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

Constructor Details

Conditions

public Conditions()

Method Details

checkArgument

public static void checkArgument(boolean argument)
                          throws IllegalArgumentException

Throw an error if the provided argument is `false`

Parameters:

argument - argument

Throws:

IllegalArgumentException - if argument is `false`

checkArgument

public static void checkArgument(boolean argument,
 @Nullable
 @Nullable String message)
                          throws IllegalArgumentException

Throw an error if the provided argument is `false`

Parameters:

argument - argument

message - message in the exception, when thrown

Throws:

IllegalArgumentException - if argument is `false`

checkRange

public static <T extends Number> T checkRange(T num,
 T min,
 T max)
                                       throws IllegalNumberRangeException

Check if a number is in a range and throw an exception if not

Parameters:

num - Number to check

min - Range minimum

max - Range maximum

Returns:

the provided `num`

Throws:

IllegalNumberRangeException - if num is lower than min or higher then max

checkRange

public static <T extends Number> T checkRange(T num,
 T min,
 T max,
 @Nullable
 @Nullable String message)
                                       throws IllegalNumberRangeException

Check if a number is in a range and throw an exception if not

Parameters:

num - Number to check

min - Range minimum

max - Range maximum

message - message in the exception, if thrown

Returns:

the provided `num`

Throws:

IllegalNumberRangeException - if num is lower than min or higher then max

checkState

public static void checkState(boolean state)
                       throws IllegalStateException

Check a `boolean` and throw an exception if it is `false`

Parameters:

state - state

Throws:

IllegalStateException - if state is `false`

checkState

public static void checkState(boolean state,
 @Nullable
 @Nullable String message)
                       throws IllegalStateException

Check a `boolean` and throw an exception if it is `false`

Parameters:

state - state

message - message in the exception, if thrown

Throws:

IllegalStateException - if state is `false`

checkNonNull

@Contract("null -> fail; !null -> param1")
public static <T> T checkNonNull(@Nullable
 T obj)
                          throws NullPointerException

Check if an object is not `null` and throw an exception if it is

Parameters:

obj - object

Throws:

NullPointerException - if obj is null

checkNonNull

@Contract("null, _ -> fail; !null, _ -> param1")
public static <T> T checkNonNull(@Nullable
 T obj,
 @Nullable
 @Nullable String message)
                          throws NullPointerException

Check if an object is not `null` and throw an exception if it is

Parameters:

obj - object

message - message in the exception, when thrown

Throws:

NullPointerException - if obj is null

checkNull

@Contract("!null -> fail")
public static <T> void checkNull(@Nullable
 T obj)
                          throws NotNullException

Check if an object is `null` and throw an exception if it is

Parameters:

obj - object

Throws:

NotNullException - if obj is not null

checkNull

@Contract("!null, _ -> fail")
public static <T> void checkNull(@Nullable
 T obj,
 @Nullable
 @Nullable String message)
                          throws NotNullException

Check if an object is `null` and throw an exception if it is

Parameters:

obj - object

message - message in the exception, when thrown

Throws:

NotNullException - if obj is not null