edu.hm.hafner.util

Class Ensure.ObjectCondition

java.lang.Object

edu.hm.hafner.util.Ensure.ObjectCondition

Direct Known Subclasses:

Ensure.ArrayCondition, Ensure.IterableCondition, Ensure.StringCondition

Enclosing class:

Ensure

public static class Ensure.ObjectCondition
extends Object

Assertions for objects.

Constructor Summary

Constructors

Constructor and Description
ObjectCondition(Object value) Creates a new instance of ObjectCondition.
ObjectCondition(Object value, Object... additionalValues) Creates a new instance of ObjectCondition.

Method Summary

Modifier and Type	Method and Description
void	isInstanceOf(Class<?> type, Class<?>... additionalTypes) Ensures that the given object is an instance of one of the specified types.
void	isInstanceOf(Class<?> type, String explanation, Object... args) Ensures that the given object is an instance of the specified type.
void	isNotNull() Ensures that the given object is not null.
void	isNotNull(String explanation, Object... args) Ensures that the given object is not null.
void	isNull() Ensures that the given object is null.
void	isNull(String explanation, Object... args) Ensures that the given object is null.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectCondition

public ObjectCondition(@CheckForNull
                       Object value)

Creates a new instance of ObjectCondition.

Parameters:

value - value of the condition

ObjectCondition

public ObjectCondition(@CheckForNull
                       Object value,
                       @CheckForNull
                       Object... additionalValues)

Creates a new instance of ObjectCondition.

Parameters:

value - value of the condition

additionalValues - additional values of the condition

Method Detail

isNotNull

public void isNotNull()

Ensures that the given object is not null.

Throws:

AssertionError - if the object is null

isNotNull

@FormatMethod
public void isNotNull(String explanation,
                                    Object... args)

Ensures that the given object is not null.

Parameters:

explanation - a formatted message explaining the assertion

args - Arguments referenced by the format specifiers in the formatted explanation. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.

Throws:

AssertionError - if the object is null

isNull

public void isNull()

Ensures that the given object is null.

Throws:

AssertionError - if the object is not null

isNull

@FormatMethod
public void isNull(String explanation,
                                 Object... args)

Ensures that the given object is null.

Parameters:

explanation - a formatted message explaining the assertion

args - Arguments referenced by the format specifiers in the formatted explanation. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.

Throws:

AssertionError - if the object is not null

isInstanceOf

public void isInstanceOf(Class<?> type,
                         Class<?>... additionalTypes)

Ensures that the given object is an instance of one of the specified types.

Parameters:

type - the type to check the specified object for

additionalTypes - the additional types to check the specified object for

Throws:

AssertionError - the specified object is not an instance of the given type (or null)

isInstanceOf

@FormatMethod
public void isInstanceOf(Class<?> type,
                                       String explanation,
                                       Object... args)

Ensures that the given object is an instance of the specified type.

Parameters:

type - the type to check the specified object for

explanation - a formatted message explaining the assertion

args - Arguments referenced by the format specifiers in the formatted explanation. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.

Throws:

AssertionError - the specified object is not an instance of the given type (or null)