net.itrixlabs.cache.util

Class Assert

java.lang.Object

net.itrixlabs.cache.util.Assert

public final class Assert
extends Object

Internal class for making application logic related assertions.

Utility methods provided by this class may be used in the application (however, extending this class itself is not allowed) for making clean assertions and avoiding condition blocks. Designed for making application logic look clean and work fast.

However, it is undesirable to instantiate (and not required too) this class anywhere in the application.

Further, extension is also not allowed as it may have side effects (not to mention, methods of this class use reflective code to perform some difficult operations).

Since:

November 11^th, 2015

Author:

Abhinav Rai

Constructor Summary

Constructors

Constructor and Description
Assert()

Method Summary

Modifier and Type	Method and Description
static void	assertEquals(Object... args) Tests the given arguments for equality based upon the Object.equals(Object) method of the class in focus and throws an IllegalArgumentException with a default message if the arguments are not equal.
static void	assertEquals(Object arg1, Object arg2) Tests the given arguments for equality based upon the Object.equals(Object) method of the class in focus and throws an IllegalArgumentException with a default message if the arguments are not equal.
static void	assertEquals(Object arg1, Object arg2, String message) Tests the given arguments for equality based upon the Object.equals(Object) method of the class in focus and throws an IllegalArgumentException with the provided message if the arguments are not equal.
static void	assertNotEmpty(Object... args) Tests the given arguments of type String, StringBuilder or StringBuffer for empty (but not null) value and throws an IllegalArgumentException with a default message if any argument is an empty string literal or representation.
static void	assertNotEmpty(Object arg) Tests the given argument of type String, StringBuilder or StringBuffer for empty (but not null) value and throws an IllegalArgumentException with a default message if the argument is an empty string literal or representation.
static void	assertNotEmpty(Object arg, String message) Tests the given argument of type String, StringBuilder or StringBuffer for empty (but not null) value and throws an IllegalArgumentException with the provided message if the argument is an empty string literal or representation.
static void	assertNotNull(Object... args) Tests the given arguments for null identity and throws an IllegalArgumentException with a default message if any argument is null.
static void	assertNotNull(Object arg) Tests the given argument for null identity and throws an IllegalArgumentException with a default message if the argument is null.
static void	assertNotNull(Object arg, String message) Tests the given argument for null identity and throws an IllegalArgumentException with the provided message if the argument is null.
static void	assertTrue(boolean... conditions) Tests the given conditions for truth and throws an IllegalArgumentException with a default message if any condition is false.
static void	assertTrue(boolean condition) Tests the given condition for truth and throws an IllegalArgumentException with a default message if the condition is false.
static void	assertTrue(boolean condition, String message) Tests the given condition for truth and throws an IllegalArgumentException with the provided message if the condition is false.

Methods inherited from class java.lang.Object

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

Constructor Detail

Assert

public Assert()

Method Detail

assertNotNull

public static void assertNotNull(Object arg,
                                 String message)
                          throws IllegalArgumentException

Tests the given argument for null identity and throws an IllegalArgumentException with the provided message if the argument is null.

Parameters:

arg - the object for null assertion

message - the message to be returned with exception if assertion fails

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertNotNull

public static void assertNotNull(Object arg)
                          throws IllegalArgumentException

Tests the given argument for null identity and throws an IllegalArgumentException with a default message if the argument is null.

Parameters:

arg - the object for null assertion

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertNotNull

public static void assertNotNull(Object... args)

Tests the given arguments for null identity and throws an IllegalArgumentException with a default message if any argument is null.

Parameters:

args - the object for null assertion

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertEquals

public static void assertEquals(Object arg1,
                                Object arg2,
                                String message)

Tests the given arguments for equality based upon the Object.equals(Object) method of the class in focus and throws an IllegalArgumentException with the provided message if the arguments are not equal. An IllegalArgumentException exception is also thrown when any of the arguments are null or the objects' classes are not assignable from each other.

It is highly recommended to override the Object.equals(Object) and Object.hashCode() methods in the class for which object comparison is desired as Object class' Object.equals(Object) method returns equality on the basis of equal identity only; which may not be always desirable.

Parameters:

arg1 - the first object argument for equality assertion

arg2 - the second object argument for equality assertion

message - the message to be returned with the exception if assertion fails

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertEquals

public static void assertEquals(Object arg1,
                                Object arg2)

Tests the given arguments for equality based upon the Object.equals(Object) method of the class in focus and throws an IllegalArgumentException with a default message if the arguments are not equal. An IllegalArgumentException exception is also thrown when any of the arguments are null or the objects' classes are not assignable from each other.

It is highly recommended to override the Object.equals(Object) and Object.hashCode() methods in the class for which object comparison is desired as Object class' Object.equals(Object) method returns equality on the basis of equal identity only; which may not be always desirable.

Parameters:

arg1 - the first object argument for equality assertion

arg2 - the second object argument for equality assertion

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertEquals

public static void assertEquals(Object... args)

Tests the given arguments for equality based upon the Object.equals(Object) method of the class in focus and throws an IllegalArgumentException with a default message if the arguments are not equal. An IllegalArgumentException exception is also thrown when any of the arguments are null or the objects' classes are not assignable from each other.

It is highly recommended to override the Object.equals(Object) and Object.hashCode() methods in the class for which object comparison is desired as Object class' Object.equals(Object) method returns equality on the basis of equal identity only; which may not be always desirable.

Parameters:

args - the object arguments for equality assertion

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertNotEmpty

public static void assertNotEmpty(Object arg,
                                  String message)

Tests the given argument of type String, StringBuilder or StringBuffer for empty (but not null) value and throws an IllegalArgumentException with the provided message if the argument is an empty string literal or representation. An IllegalArgumentException exception is also thrown if the argument is null or the object is not an instance of any one of the three popular string representations in Java.

Parameters:

arg - the object arguments for not empty assertion

message - the message to be returned with the exception if assertion fails

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertNotEmpty

public static void assertNotEmpty(Object arg)

Tests the given argument of type String, StringBuilder or StringBuffer for empty (but not null) value and throws an IllegalArgumentException with a default message if the argument is an empty string literal or representation. An IllegalArgumentException exception is also thrown if the argument is null or the object is not an instance of any one of the three popular string representations in Java.

Parameters:

arg - the object argument for not empty assertion

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertNotEmpty

public static void assertNotEmpty(Object... args)

Tests the given arguments of type String, StringBuilder or StringBuffer for empty (but not null) value and throws an IllegalArgumentException with a default message if any argument is an empty string literal or representation. An IllegalArgumentException exception is also thrown if any argument is null or the object is not an instance of any one of the three popular string representations in Java.

Parameters:

args - the object arguments for not empty assertion

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertTrue

public static void assertTrue(boolean condition,
                              String message)

Tests the given condition for truth and throws an IllegalArgumentException with the provided message if the condition is false.

Parameters:

condition - the condition for truth assertion

message - the message to be returned with the exception if assertion fails

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertTrue

public static void assertTrue(boolean condition)

Tests the given condition for truth and throws an IllegalArgumentException with a default message if the condition is false.

Parameters:

condition - the condition for truth assertion

Throws:

IllegalArgumentException - exception thrown if assertion fails

assertTrue

public static void assertTrue(boolean... conditions)

Tests the given conditions for truth and throws an IllegalArgumentException with a default message if any condition is false.

Parameters:

conditions - the conditions for truth assertion

Throws:

IllegalArgumentException - exception thrown if assertion fails