org.conqat.lib.commons.assertion

Class CCSMAssert

java.lang.Object

org.conqat.lib.commons.assertion.CCSMAssert

public class CCSMAssert
extends java.lang.Object

This class provides simple methods to implement assertions. Please refer to the package documentation for a discussion of assertions vs preconditions.

Constructor Summary

Constructors

Constructor and Description
CCSMAssert()

Method Summary

Modifier and Type	Method and Description
static <T> T	checkedCast(java.lang.Object object, java.lang.Class<T> clazz) This calls isInstanceOf(Object, Class) and, if this doesn't fail returns the casted object.
static void	fail(java.lang.String message)
static void	fail(java.lang.String message, java.lang.Throwable t)
static void	isFalse(boolean condition, java.lang.String message) Checks if a condition is false.
static void	isFalse(boolean condition, java.util.function.Supplier<java.lang.String> messageSupplier) Checks if a condition is false.
static void	isInstanceOf(java.lang.Object object, java.lang.Class<?> clazz) Checks that the object is a instance of the class.
static void	isNotEmpty(java.util.Collection<?> collection, java.lang.String message)
static void	isNotEmpty(java.util.Collection<?> collection, java.util.function.Supplier<java.lang.String> messageSupplier) Checks whether a collection is null or empty.
static void	isNotEmpty(java.lang.String s, java.lang.String message)
static void	isNotEmpty(java.lang.String s, java.util.function.Supplier<java.lang.String> messageSupplier) Checks whether a String is null or empty.
static void	isNotNull(java.lang.Object reference) Checks whether a reference is null.
static void	isNotNull(java.lang.Object reference, java.lang.String message) Checks whether a reference is null.
static void	isNotNull(java.lang.Object reference, java.util.function.Supplier<java.lang.String> messageSupplier) Checks whether a reference is null.
static void	isPresent(java.util.Optional<?> optional, java.lang.String message)
static void	isPresent(java.util.Optional<?> optional, java.util.function.Supplier<java.lang.String> messageSupplier) Checks whether an Optional is present.
static void	isTrue(boolean condition, java.lang.String message) Checks if a condition is true.
static void	isTrue(boolean condition, java.util.function.Supplier<java.lang.String> messageSupplier) Checks if a condition is true.

Methods inherited from class java.lang.Object

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

Constructor Detail

CCSMAssert

public CCSMAssert()

Method Detail

isTrue

public static void isTrue(boolean condition,
                          java.lang.String message)
                   throws java.lang.AssertionError

Checks if a condition is true.

Parameters:

condition - condition to check

message - exception message

Throws:

java.lang.AssertionError - if the condition is false

isTrue

public static void isTrue(boolean condition,
                          java.util.function.Supplier<java.lang.String> messageSupplier)
                   throws java.lang.AssertionError

Checks if a condition is true.

Parameters:

condition - condition to check

messageSupplier - supplier for the exception message evaluated in case the assertion fails

Throws:

java.lang.AssertionError - if the condition is false

isFalse

public static void isFalse(boolean condition,
                           java.lang.String message)
                    throws java.lang.AssertionError

Checks if a condition is false.

Parameters:

condition - condition to check

message - exception message

Throws:

java.lang.AssertionError - if the condition is true

isFalse

public static void isFalse(boolean condition,
                           java.util.function.Supplier<java.lang.String> messageSupplier)
                    throws java.lang.AssertionError

Checks if a condition is false.

Parameters:

condition - condition to check

messageSupplier - supplier for the exception message evaluated in case the assertion fails

Throws:

java.lang.AssertionError - if the condition is true

isInstanceOf

public static void isInstanceOf(java.lang.Object object,
                                java.lang.Class<?> clazz)

Checks that the object is a instance of the class.

checkedCast

public static <T> T checkedCast(java.lang.Object object,
                                java.lang.Class<T> clazz)

This calls isInstanceOf(Object, Class) and, if this doesn't fail returns the casted object.

fail

public static void fail(java.lang.String message,
                        java.lang.Throwable t)
                 throws java.lang.AssertionError

Throws:

java.lang.AssertionError - with message and throwable

fail

public static void fail(java.lang.String message)
                 throws java.lang.AssertionError

Throws:

java.lang.AssertionError - with message

isNotNull

public static void isNotNull(java.lang.Object reference)
                      throws java.lang.AssertionError

Checks whether a reference is null.

Parameters:

reference - reference to check

Throws:

java.lang.AssertionError - if the reference is null

isNotNull

public static void isNotNull(java.lang.Object reference,
                             java.lang.String message)
                      throws java.lang.AssertionError

Checks whether a reference is null.

Parameters:

reference - reference to check

message - exception message

Throws:

java.lang.AssertionError - if the reference is null

isNotNull

public static void isNotNull(java.lang.Object reference,
                             java.util.function.Supplier<java.lang.String> messageSupplier)
                      throws java.lang.AssertionError

Checks whether a reference is null.

Parameters:

reference - reference to check

messageSupplier - supplier for the exception message evaluated in case the assertion fails

Throws:

java.lang.AssertionError - if the reference is null

isNotEmpty

public static void isNotEmpty(java.lang.String s,
                              java.lang.String message)
                       throws java.lang.AssertionError

Throws:

java.lang.AssertionError

See Also:

isNotNull(Object, Supplier)

isNotEmpty

public static void isNotEmpty(java.lang.String s,
                              java.util.function.Supplier<java.lang.String> messageSupplier)
                       throws java.lang.AssertionError

Checks whether a String is null or empty.

Parameters:

s - String to check

messageSupplier - supplier for the exception message evaluated in case the assertion fails

Throws:

java.lang.AssertionError - if the String is empty

isNotEmpty

public static void isNotEmpty(java.util.Collection<?> collection,
                              java.lang.String message)
                       throws java.lang.AssertionError

Throws:

java.lang.AssertionError

See Also:

isNotEmpty(Collection, Supplier)

isNotEmpty

public static void isNotEmpty(java.util.Collection<?> collection,
                              java.util.function.Supplier<java.lang.String> messageSupplier)
                       throws java.lang.AssertionError

Checks whether a collection is null or empty.

Parameters:

collection - Collection to check

messageSupplier - supplier for the exception message evaluated in case the assertion fails

Throws:

java.lang.AssertionError - if the collection is empty

isPresent

public static void isPresent(java.util.Optional<?> optional,
                             java.lang.String message)

See Also:

isPresent(Optional, Supplier)

isPresent

public static void isPresent(java.util.Optional<?> optional,
                             java.util.function.Supplier<java.lang.String> messageSupplier)

Checks whether an Optional is present.

Parameters:

optional - Optional to check

messageSupplier - supplier for the exception message evaluated in case the assertion fails

Throws:

java.lang.AssertionError - if the Optional is not present