de.julielab.java.utilities.prerequisites

Class PrerequisiteChecker

java.lang.Object

de.julielab.java.utilities.prerequisites.PrerequisiteChecker

public class PrerequisiteChecker
extends Object

This is a class meant for chaining together calls like PrerequisiteChecker.checkThat().notNull(ob1, ob2).notEmpty(coll).withNames("ob1", "ob2", "coll").execute(). In case that any of the checks fail on execute(), a message will be recorded for each failed check. Then, an IllegalArgumentException is thrown explaining what went wrong.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREREQUISITE_CHECKS_ENABLED

Method Summary

Modifier and Type	Method and Description
static PrerequisiteChecker	checkThat()
void	execute() Checks for null items and, if found, generates an error message.
PrerequisiteChecker	notEmpty(Collection<?>... collections)
PrerequisiteChecker	notNull(Object... objects)
PrerequisiteChecker	supplyNotEmpty(java.util.function.Supplier<Collection<?>>... collections)
PrerequisiteChecker	supplyNotNull(java.util.function.Supplier<?>... objectSuppliers)
PrerequisiteChecker	withNames(String... names) Sets the names for all items previously added to the checker, possibly in multiple calls.

Methods inherited from class java.lang.Object

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

Field Detail

PREREQUISITE_CHECKS_ENABLED

public static final String PREREQUISITE_CHECKS_ENABLED

See Also:

Constant Field Values

Method Detail

checkThat

public static PrerequisiteChecker checkThat()

withNames

public PrerequisiteChecker withNames(String... names)

Sets the names for all items previously added to the checker, possibly in multiple calls. The number of names may lower or even higher than the number of given items. In the first case, the names will be assigned to the checked items from left to right in a continuous manner while the remaining items will receive null as their name. In the second case, all superfluous names will simply be ignored.

Parameters:

names - The names to give to the last list of items to check

Returns:

This object for chaining.

notNull

public PrerequisiteChecker notNull(Object... objects)

notEmpty

public PrerequisiteChecker notEmpty(Collection<?>... collections)

supplyNotEmpty

public PrerequisiteChecker supplyNotEmpty(java.util.function.Supplier<Collection<?>>... collections)

supplyNotNull

public PrerequisiteChecker supplyNotNull(java.util.function.Supplier<?>... objectSuppliers)

execute

public void execute()

Checks for null items and, if found, generates an error message.