ValidationUtils (enterprisemath-utils 2.4.0 API)

java.lang.Object
- com.enterprisemath.utils.ValidationUtils

```
public class ValidationUtils
extends Object
```
This class contains the static methods which simplifies the validation of the simple fields and properties. Methods with pattern guardXXX guards code to pass function if tested variable does not particular criteria. In that case IllegalArgumentException is thrown. If variable satisfy the criteria, then function does nothing.

Author:

radek.hecl

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`guardBoundedDouble(double number, String msg)` Guards number to not be POSITIVE_INFINITY, NEGATIVE_INFINITY, NaN.
`static void`	`guardClosedIntervalDouble(double number, double min, double max, String msg)` Guards double to be in the closed interval.
`static void`	`guardEmpty(String str, String msg)` Guards string to be empty.
`static void`	`guardEquals(Object obj1, Object obj2, String msg)` Guards two object to be equal.
`static void`	`guardFalse(boolean obj, String msg)` Guards object to be false.
`static void`	`guardGetterExistsForEnum(Class<?> clazz, Enum<?> enm, String msg)` Guards given class to have getter for the specified enumeration value.
`static void`	`guardGreaterDouble(double number1, double number2, String msg)` Guards number1 to be greater than number2.
`static void`	`guardGreaterOrEqualDouble(double number1, double number2, String msg)` Guards number1 to be greater or equal number2.
`static void`	`guardGreaterOrEqualInt(int number1, int number2, String msg)` Guards number1 to be greater or equal number2.
`static void`	`guardGreaterOrEqualLong(long number1, long number2, String msg)` Guards number1 to be greater or equal number2.
`static void`	`guardIn(Object obj, Collection<?> allowed, String msg)` Guards object to be one of the specified values.
`static void`	`guardInstanceOf(Object obj, Class<?> clazz, String msg)` Guard object to be instance of the specified class.
`static void`	`guardIpString(String ip, String msg)` Guards String to be an IP address.
`static void`	`guardMatch(String str, String regex, String msg)` Guards string to match the regular expression.
`static void`	`guardNotEmpty(String str, String msg)` Guards string to be not empty.
`static <V> void`	`guardNotEmptyNullMap(Map<String,V> map, String msg)` Guards that map has all keys not empty strings and all values are not null.
`static void`	`guardNotEmptyStringInCollection(Collection<String> collection, String msg)` Guards that collection is not null and also any element inside is not null or empty string.
`static void`	`guardNotNegativeDouble(double number, String msg)` Guards that specified number is greater or equal to 0.
`static void`	`guardNotNegativeInt(int number, String msg)` Guards that the specified number is 0, 1, 2...
`static void`	`guardNotNegativeLong(long number, String msg)` Guards that the specified number is 0, 1, 2...
`static void`	`guardNotNull(Object obj, String msg)` Guards object to be not null.
`static <T> void`	`guardNotNullCollection(Collection<T> collection, String msg)` Guards that collection is not null and also any element inside is not null.
`static <K,V> void`	`guardNotNullMap(Map<K,V> map, String msg)` Guards that map is not null and also all the keys and values are not null.
`static void`	`guardNotZeroInt(int obj, String msg)` Guards integer to be non zero.
`static void`	`guardNotZeroLong(long obj, String msg)` Guards long to be one non zero.
`static void`	`guardNull(Object obj, String msg)` Guards object to be null.
`static void`	`guardPositiveDouble(double number, String msg)` Guards that specified number is greater then 0.
`static void`	`guardPositiveInt(int number, String msg)` Guards that specified number is 1, 2, 3...
`static void`	`guardPositiveLong(long number, String msg)` Guards that specified number is 1, 2, 3...
`static void`	`guardTrue(boolean obj, String msg)` Guards object to be true.
`static void`	`guardTruncatedDate(Date date, String msg)` Guards date object to be the date only, without time component.

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

- Method Detail
  - guardTrue
```
public static void guardTrue(boolean obj,
                             String msg)
```
    Guards object to be true.
    
    Parameters:
    
    obj - tested object
    
    msg - message to appear in the exception
  - guardFalse
```
public static void guardFalse(boolean obj,
                              String msg)
```
    Guards object to be false.
    
    Parameters:
    
    obj - tested object
    
    msg - message to appear in the exception
  - guardNull
```
public static void guardNull(Object obj,
                             String msg)
```
    Guards object to be null.
    
    Parameters:
    
    obj - tested object
    
    msg - message to appear in the exception
  - guardNotNull
```
public static void guardNotNull(Object obj,
                                String msg)
```
    Guards object to be not null.
    
    Parameters:
    
    obj - tested object
    
    msg - message to appear in the exception
  - guardEmpty
```
public static void guardEmpty(String str,
                              String msg)
```
    Guards string to be empty. Empty means both null and empty string.
    
    Parameters:
    
    str - tested string
    
    msg - message to appear in the exception
  - guardNotEmpty
```
public static void guardNotEmpty(String str,
                                 String msg)
```
    Guards string to be not empty. Empty means both null and empty string.
    
    Parameters:
    
    str - tested string
    
    msg - message to appear in the exception
  - guardMatch
```
public static void guardMatch(String str,
                              String regex,
                              String msg)
```
    Guards string to match the regular expression.
    
    Parameters:
    
    str - tested string, not null
    
    regex - regular expression which needs to be satisfied
    
    msg - name of to put into exception message
  - guardNotNullCollection
```
public static <T> void guardNotNullCollection(Collection<T> collection,
                                              String msg)
```
    Guards that collection is not null and also any element inside is not null.
    
    Type Parameters:
    
    T - type of the object in the collection
    
    Parameters:
    
    collection - tested object
    
    msg - name of to put into exception message
  - guardNotEmptyStringInCollection
```
public static void guardNotEmptyStringInCollection(Collection<String> collection,
                                                   String msg)
```
    Guards that collection is not null and also any element inside is not null or empty string. Empty collection (size = 0) is fine.
    
    Parameters:
    
    collection - tested object
    
    msg - name of to put into exception message
  - guardNotNullMap
```
public static <K,V> void guardNotNullMap(Map<K,V> map,
                                         String msg)
```
    Guards that map is not null and also all the keys and values are not null.
    
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Parameters:
    
    map - tested object
    
    msg - massage which appears in exception when validation failed
  - guardNotEmptyNullMap
```
public static <V> void guardNotEmptyNullMap(Map<String,V> map,
                                            String msg)
```
    Guards that map has all keys not empty strings and all values are not null.
    
    Type Parameters:
    
    V - value type
    
    Parameters:
    
    map - tested object
    
    msg - massage which appears in exception when validation failed
  - guardNotNegativeInt
```
public static void guardNotNegativeInt(int number,
                                       String msg)
```
    Guards that the specified number is 0, 1, 2...
    
    Parameters:
    
    number - tested number
    
    msg - message in case of error
  - guardPositiveInt
```
public static void guardPositiveInt(int number,
                                    String msg)
```
    Guards that specified number is 1, 2, 3...
    
    Parameters:
    
    number - tested number
    
    msg - message to appear in the exception
  - guardPositiveLong
```
public static void guardPositiveLong(long number,
                                     String msg)
```
    Guards that specified number is 1, 2, 3...
    
    Parameters:
    
    number - tested number
    
    msg - message to appear in the exception
  - guardNotZeroLong
```
public static void guardNotZeroLong(long obj,
                                    String msg)
```
    Guards long to be one non zero.
    
    Parameters:
    
    obj - object to test
    
    msg - message to appear in the exception
  - guardNotZeroInt
```
public static void guardNotZeroInt(int obj,
                                   String msg)
```
    Guards integer to be non zero.
    
    Parameters:
    
    obj - object to test
    
    msg - message to appear in the exception
  - guardPositiveDouble
```
public static void guardPositiveDouble(double number,
                                       String msg)
```
    Guards that specified number is greater then 0. Fails for NaN.
    
    Parameters:
    
    number - tested number
    
    msg - message to appear in the exception
  - guardBoundedDouble
```
public static void guardBoundedDouble(double number,
                                      String msg)
```
    Guards number to not be POSITIVE_INFINITY, NEGATIVE_INFINITY, NaN.
    
    Parameters:
    
    number - tested number
    
    msg - message to appear in the exception
  - guardClosedIntervalDouble
```
public static void guardClosedIntervalDouble(double number,
                                             double min,
                                             double max,
                                             String msg)
```
    Guards double to be in the closed interval. This means both end points are permitted.
    
    Parameters:
    
    number - number to test
    
    min - minimum
    
    max - maximum
    
    msg - message to appear in the exception
  - guardNotNegativeLong
```
public static void guardNotNegativeLong(long number,
                                        String msg)
```
    Guards that the specified number is 0, 1, 2...
    
    Parameters:
    
    number - tested number
    
    msg - message to appear in the exception
  - guardNotNegativeDouble
```
public static void guardNotNegativeDouble(double number,
                                          String msg)
```
    Guards that specified number is greater or equal to 0. Fails for NaN.
    
    Parameters:
    
    number - tested number
    
    msg - message to appear in the exception
  - guardIpString
```
public static void guardIpString(String ip,
                                 String msg)
```
    Guards String to be an IP address. Right now this method supports only IPv4. Later IPv6 can pass the validation.
    
    Parameters:
    
    ip - tested string to be an IP address
    
    msg - message to appear in the exception
  - guardEquals
```
public static void guardEquals(Object obj1,
                               Object obj2,
                               String msg)
```
    Guards two object to be equal. This is null safe, where two null objects are considered to be equal.
    
    Parameters:
    
    obj1 - object one
    
    obj2 - object two
    
    msg - message to appear in the exception
  - guardGreaterDouble
```
public static void guardGreaterDouble(double number1,
                                      double number2,
                                      String msg)
```
    Guards number1 to be greater than number2. Fails if number1 or number2 is NaN.
    
    Parameters:
    
    number1 - number1 - the one which must be greater
    
    number2 - number2 - the one which must be less
    
    msg - message to appear in the exception
  - guardGreaterOrEqualInt
```
public static void guardGreaterOrEqualInt(int number1,
                                          int number2,
                                          String msg)
```
    Guards number1 to be greater or equal number2.
    
    Parameters:
    
    number1 - number1 - the one which must be greater or equal
    
    number2 - number2 - the one which must be less or equal
    
    msg - message to appear in the exception
  - guardGreaterOrEqualLong
```
public static void guardGreaterOrEqualLong(long number1,
                                           long number2,
                                           String msg)
```
    Guards number1 to be greater or equal number2.
    
    Parameters:
    
    number1 - number1 - the one which must be greater or equal
    
    number2 - number2 - the one which must be less or equal
    
    msg - message to appear in the exception
  - guardGreaterOrEqualDouble
```
public static void guardGreaterOrEqualDouble(double number1,
                                             double number2,
                                             String msg)
```
    Guards number1 to be greater or equal number2. Fails if number1 or number2 is NaN.
    
    Parameters:
    
    number1 - number1 - the one which must be greater or equal
    
    number2 - number2 - the one which must be less or equal
    
    msg - message to appear in the exception
  - guardInstanceOf
```
public static void guardInstanceOf(Object obj,
                                   Class<?> clazz,
                                   String msg)
```
    Guard object to be instance of the specified class. Null is not an instance of any class and if obj is null, then guard method will NOT pass.
    
    Parameters:
    
    obj - tested object
    
    clazz - class which is used for the test
    
    msg - message to appear in the exception
  - guardIn
```
public static void guardIn(Object obj,
                           Collection<?> allowed,
                           String msg)
```
    Guards object to be one of the specified values.
    
    Parameters:
    
    obj - object to test
    
    allowed - collection of allowed values
    
    msg - message to appear in the exception
  - guardTruncatedDate
```
public static void guardTruncatedDate(Date date,
                                      String msg)
```
    Guards date object to be the date only, without time component. If there is any field less significant than day, then it is wrong. Also if date is null, then it is wrong.
    
    Parameters:
    
    date - date object to be tested as date
    
    msg - message to appear in the exception
  - guardGetterExistsForEnum
```
public static void guardGetterExistsForEnum(Class<?> clazz,
                                            Enum<?> enm,
                                            String msg)
```
    Guards given class to have getter for the specified enumeration value. First searches for getter which starting with "get". If this getter is not presented, then search for the one which starting with "is". If even this one doesn't exists, then it's validation error. Examples of expected getters for a specified enumeration:
    - ID => getId(), isId()
    - EVENT_TIMESTAMP => getEventTimestamp(), isEventTimestamp()
    Note: This method uses reflection, so speed is not great.
    Parameters:
    
    clazz - class for which getter should be checked
    
    enm - enumeration value
    
    msg - message to appear in the exception

Class ValidationUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

guardTrue

guardFalse

guardNull

guardNotNull

guardEmpty

guardNotEmpty

guardMatch

guardNotNullCollection

guardNotEmptyStringInCollection

guardNotNullMap

guardNotEmptyNullMap

guardNotNegativeInt

guardPositiveInt

guardPositiveLong

guardNotZeroLong

guardNotZeroInt

guardPositiveDouble

guardBoundedDouble

guardClosedIntervalDouble

guardNotNegativeLong

guardNotNegativeDouble

guardIpString

guardEquals

guardGreaterDouble

guardGreaterOrEqualInt

guardGreaterOrEqualLong

guardGreaterOrEqualDouble

guardInstanceOf

guardIn

guardTruncatedDate

guardGetterExistsForEnum