uk.kludje

Class Ensure

java.lang.Object

uk.kludje.Ensure

public final class Ensure
extends java.lang.Object

Provides convenience methods for asserting conditions. Not called Assert because JUnit etc. If in doubt, use that(boolean, String).

Method Summary

Modifier and Type	Method and Description
static <T extends java.lang.Throwable> void	checked(boolean predicate, java.lang.String explanation, java.util.function.Function<java.lang.String,T> exceptionFactory) Usage: Ensure.checked(connection != null, "connection != null", IOException::new); The throwable type must have a constructor checked just takes a String.
static void	that(boolean predicate, java.lang.String explanation) Throws an AssertionError if predicate is false.
static <T extends java.lang.Throwable> void	unchecked(boolean predicate, java.lang.String explanation, java.util.function.Function<java.lang.String,T> exceptionFactory) As checked(boolean, String, Function) except the throwable is thrown as an unchecked exception type.

Methods inherited from class java.lang.Object

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

Method Detail

checked

public static <T extends java.lang.Throwable> void checked(boolean predicate,
                                                           java.lang.String explanation,
                                                           java.util.function.Function<java.lang.String,T> exceptionFactory)
                                                    throws T extends java.lang.Throwable

Usage: Ensure.checked(connection != null, "connection != null", IOException::new); The throwable type must have a constructor checked just takes a String.

Type Parameters:

T - the type to throw

Parameters:

predicate - the condition

explanation - failure reason

exceptionFactory - source of error

Throws:

T - if predicate is false

T extends java.lang.Throwable

that

public static void that(boolean predicate,
                        java.lang.String explanation)

Throws an AssertionError if predicate is false. Usage: Ensure.that(foo != null, "foo != null");

Parameters:

predicate - the condition

explanation - failure reason

unchecked

public static <T extends java.lang.Throwable> void unchecked(boolean predicate,
                                                             java.lang.String explanation,
                                                             java.util.function.Function<java.lang.String,T> exceptionFactory)

As checked(boolean, String, Function) except the throwable is thrown as an unchecked exception type.

Type Parameters:

T - the type to throw

Parameters:

predicate - the condition

explanation - failure reason

exceptionFactory - source of error

See Also:

Exceptions.throwChecked(Throwable)