com.applitools.utils

Class ArgumentGuard

java.lang.Object

com.applitools.utils.ArgumentGuard

public class ArgumentGuard
extends Object

Argument validation utilities.

Method Summary

Modifier and Type	Method and Description
static void	greaterThanOrEqualToZero(long param, String paramName) Fails if the input integer parameter is negative.
static void	greaterThanZero(double param, String paramName) Fails if the input integer parameter is below or equal to 0.
static void	greaterThanZero(long param, String paramName) Fails if the input integer parameter is smaller than 1.
static void	isNull(Object param, String paramName) Fails if the input parameter is not null.
static void	isValidState(boolean isValid, String errMsg) Fails if isValid is false.
static void	notEqual(Object param, Object value, String paramName) Fails if the input parameter equals the input value.
static void	notNull(Object param, String paramName) Fails if the input parameter is null.
static void	notNullOrEmpty(String param, String paramName) Fails if the input parameter string is null or empty.
static void	notZero(long param, String paramName) Fails if the input integer parameter is equal to 0.

Methods inherited from class java.lang.Object

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

Method Detail

notNull

public static void notNull(Object param,
                           String paramName)
                    throws IllegalArgumentException

Fails if the input parameter is null.

Parameters:

param - The input parameter.

paramName - The input parameter name.

Throws:

IllegalArgumentException

notEqual

public static void notEqual(Object param,
                            Object value,
                            String paramName)

Fails if the input parameter equals the input value.

Parameters:

param - The input parameter.

value - The input value.

paramName - The input parameter name.

notNullOrEmpty

public static void notNullOrEmpty(String param,
                                  String paramName)
                           throws IllegalArgumentException

Fails if the input parameter string is null or empty.

Parameters:

param - The input parameter.

paramName - The input parameter name.

Throws:

IllegalArgumentException

isNull

public static void isNull(Object param,
                          String paramName)
                   throws IllegalArgumentException

Fails if the input parameter is not null.

Parameters:

param - The input parameter.

paramName - The input parameter name.

Throws:

IllegalArgumentException

greaterThanOrEqualToZero

public static void greaterThanOrEqualToZero(long param,
                                            String paramName)
                                     throws IllegalArgumentException

Fails if the input integer parameter is negative.

Parameters:

param - The input parameter.

paramName - The input parameter name.

Throws:

IllegalArgumentException

greaterThanZero

public static void greaterThanZero(long param,
                                   String paramName)
                            throws IllegalArgumentException

Fails if the input integer parameter is smaller than 1.

Parameters:

param - The input parameter.

paramName - The input parameter name.

Throws:

IllegalArgumentException

greaterThanZero

public static void greaterThanZero(double param,
                                   String paramName)
                            throws IllegalArgumentException

Fails if the input integer parameter is below or equal to 0.

Parameters:

param - The input parameter.

paramName - The input parameter name.

Throws:

IllegalArgumentException

notZero

public static void notZero(long param,
                           String paramName)
                    throws IllegalArgumentException

Fails if the input integer parameter is equal to 0.

Parameters:

param - The input parameter.

paramName - The input parameter name.

Throws:

IllegalArgumentException

isValidState

public static void isValidState(boolean isValid,
                                String errMsg)
                         throws IllegalStateException

Fails if isValid is false.

Parameters:

isValid - Whether the current state is valid.

errMsg - A description of the error.

Throws:

IllegalStateException