org.openhubframework.openhub.api.common

Class Constraints

java.lang.Object

org.openhubframework.openhub.api.common.Constraints

public final class Constraints
extends Object

Assertion utility class that assists in validating arguments by throwing specific ValidationException exceptions.

Useful for identifying data integration errors early and clearly at runtime.

For example, if the contract of a public method states it does not allow null arguments, Constraints can be used to validate that contract. Doing this clearly indicates a contract violation when it occurs and protects the class's invariants.

Author:

Tomas Hanus

Method Summary

Modifier and Type	Method and Description
static void	hasText(String text, String message) Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.
static void	hasText(String text, String message, ErrorExtEnum errorCode) Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.
static void	isNull(Object object, String message) Assert that an object is null.
static void	isNull(Object object, String message, ErrorExtEnum errorCode) Assert that an object is null.
static void	isTrue(Boolean expression, String message) Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
static void	isTrue(Boolean expression, String message, ErrorExtEnum errorCode) Assert a boolean expression, throwing IllegalArgumentException if the test result is false.
static void	notNull(Object object, String message) Assert that an object is not null.
static void	notNull(Object object, String message, ErrorExtEnum errorCode) Assert that an object is not null.
static void	state(boolean expression, String message) Assert a boolean expression, throwing IllegalStateException if the test result is false.

Methods inherited from class java.lang.Object

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

Method Detail

hasText

public static void hasText(String text,
                           String message)
                    throws IllegalDataException

Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.

Parameters:

text - the String to check

message - the exception message to use if the assertion fails

Throws:

IllegalDataException - occurs if text is null or does not contain nor non-whitespace character.

hasText

public static void hasText(String text,
                           String message,
                           ErrorExtEnum errorCode)
                    throws IllegalDataException

Assert that the given String has valid text content; that is, it must not be null and must contain at least one non-whitespace character.

Parameters:

text - the String to check

message - the exception message to use if the assertion fails

errorCode - the internal error code

Throws:

IllegalDataException - occurs if text is null or does not contain nor non-whitespace character.

notNull

public static void notNull(Object object,
                           String message)

Assert that an object is not null.

Assert.notNull(clazz, "The class must not be null");

Parameters:

object - the object to check

message - the exception message to use if the assertion fails

Throws:

IllegalArgumentException - if the object is null

notNull

public static void notNull(Object object,
                           String message,
                           ErrorExtEnum errorCode)

Assert that an object is not null.

Assert.notNull(clazz, "The class must not be null");

Parameters:

object - the object to check

message - the exception message to use if the assertion fails

errorCode - the internal error code

Throws:

IllegalArgumentException - if the object is null

isNull

public static void isNull(Object object,
                          String message)

Assert that an object is null.

Assert.isNull(clazz, "The class must be null");

Parameters:

object - the object to check

message - the exception message to use if the assertion fails

Throws:

IllegalArgumentException - if the object is not null

isNull

public static void isNull(Object object,
                          String message,
                          ErrorExtEnum errorCode)

Assert that an object is null.

Assert.isNull(clazz, "The class must be null");

Parameters:

object - the object to check

message - the exception message to use if the assertion fails

errorCode - the internal error code

Throws:

IllegalArgumentException - if the object is not null

isTrue

public static void isTrue(Boolean expression,
                          String message)

Assert a boolean expression, throwing IllegalArgumentException if the test result is false.

Parameters:

expression - a boolean expression

message - the exception message to use if the assertion fails

Throws:

IllegalArgumentException - if expression is false

isTrue

public static void isTrue(Boolean expression,
                          String message,
                          ErrorExtEnum errorCode)

Assert a boolean expression, throwing IllegalArgumentException if the test result is false.

Parameters:

expression - a boolean expression

message - the exception message to use if the assertion fails

errorCode - the internal error code

Throws:

IllegalArgumentException - if expression is false

state

public static void state(boolean expression,
                         String message)

Assert a boolean expression, throwing IllegalStateException if the test result is false. Call isTrue if you wish to throw IllegalArgumentException on an assertion failure.

Assert.state(id == null, "The id property must not already be initialized");

Parameters:

expression - a boolean expression

message - the exception message to use if the assertion fails

Throws:

IllegalStateException - if expression is false