org.rvpf.base.tool

Class Require

Object

Require

@Immutable
public final class Require
extends Object

Require.

Provides assertion services. Replaces the use of the 'assert' instruction which depends on a compile time switch (-ea). Also replaces the use of the AssertJ library which is expected to be run in a test environment. Also replaces the generic use of IllegalStateException with FailureException which subclasses AssertionError instead of RuntimeException.

This class does not use reflection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Require.FailureException Failure exception.

Method Summary

Modifier and Type	Method and Description
static <T> void	content(Iterable<T> iterable, String explanation, T... content) Requires a specific content for an iterable.
static <T> void	content(Iterable<T> iterable, T... content) Requires a specific content for an iterable.
static void	equal(boolean reference, boolean value) Requires boolean equal.
static void	equal(boolean reference, boolean value, Object explanation) Requires boolean equal.
static void	equal(double reference, double value) Requires double equal.
static void	equal(double reference, double value, double sample) Requires double equal.
static void	equal(double reference, double value, double sample, Object explanation) Requires double equal.
static void	equal(double reference, double value, Object explanation) Requires double equal.
static void	equal(long reference, long value) Requires long equal.
static void	equal(long reference, long value, Object explanation) Requires long equal.
static void	equal(Object reference, Object value) Requires object equal.
static void	equal(Object reference, Object value, Object explanation) Requires object equal.
static Require.FailureException	failure() Forces a failure.
static void	failure(boolean value) Failure.
static void	failure(boolean value, Object explanation) Failure.
static Require.FailureException	failure(Exception cause) Failure.
static Require.FailureException	failure(Exception cause, Object explanation) Failure.
static Require.FailureException	failure(Object explanation) Failure.
static void	ignored(boolean value) Ignores a boolean value.
static void	ignored(double value) Ignores a double value.
static void	ignored(long value) Ignores a long value.
static void	ignored(Object value) Ignores an object value.
static String	notEmpty(String string) Requires a not empty string.
static String	notEmptyTrimmed(String string) Requires a not empty trimmed string.
static <T> T	notNull(T object) Requires an object.
static <T> T	notNull(T object, Object explanation) Requires an object.
static <T> void	notPresent(Optional<T> object) Requires an optional object to not be present.
static <T> void	notPresent(Optional<T> object, Object explanation) Requires an optional object to not be present.
static <T> void	present(Optional<T> object) Requires an optional object to be present.
static <T> void	present(Optional<T> object, Object explanation) Requires an optional object to be present.
static void	same(Object reference, Object value) Requires the two arguments to be the same object.
static void	same(Object reference, Object value, Object explanation) Requires the two arguments to be the same object.
static boolean	success(boolean value) Requires success.
static boolean	success(boolean value, Object explanation) Requires success.
static void	success(Exception exception) Requires success.
static void	success(Exception exception, Object explanation) Requires success.

Methods inherited from class Object

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

Method Detail

content

@SafeVarargs
public static <T> void content(@Nonnull
                                             Iterable<T> iterable,
                                             @Nonnull
                                             T... content)

Requires a specific content for an iterable.

Type Parameters:

T - The type of the content objects.

Parameters:

iterable - The iterable.

content - The expected content.

content

@SafeVarargs
public static <T> void content(@Nonnull
                                             Iterable<T> iterable,
                                             @Nonnull
                                             String explanation,
                                             @Nonnull
                                             T... content)

Requires a specific content for an iterable.

Type Parameters:

T - The type of the content objects.

Parameters:

iterable - The iterable.

explanation - Explanatory text.

content - The expected content.

equal

public static void equal(boolean reference,
                         boolean value)

Requires boolean equal.

Parameters:

reference - The boolean reference.

value - The boolean value.

equal

public static void equal(double reference,
                         double value)

Requires double equal.

Parameters:

reference - The double reference.

value - The double value.

equal

public static void equal(long reference,
                         long value)

Requires long equal.

Parameters:

reference - The long reference.

value - The long value.

equal

public static void equal(@Nullable
                         Object reference,
                         @Nullable
                         Object value)

Requires object equal.

Parameters:

reference - The reference object.

value - The value object.

equal

public static void equal(boolean reference,
                         boolean value,
                         @Nonnull
                         Object explanation)

Requires boolean equal.

Parameters:

reference - The boolean reference.

value - The boolean value.

explanation - Explanatory text.

equal

public static void equal(double reference,
                         double value,
                         double sample)

Requires double equal.

Parameters:

reference - The double reference.

value - The double value.

sample - A sample value.

equal

public static void equal(double reference,
                         double value,
                         @Nonnull
                         Object explanation)

Requires double equal.

Parameters:

reference - The double reference.

value - The double value.

explanation - Explanatory text.

equal

public static void equal(long reference,
                         long value,
                         @Nonnull
                         Object explanation)

Requires long equal.

Parameters:

reference - The long reference.

value - The long value.

explanation - Explanatory text.

equal

public static void equal(@Nullable
                         Object reference,
                         @Nullable
                         Object value,
                         @Nonnull
                         Object explanation)

Requires object equal.

Parameters:

reference - The reference object.

value - The value object.

explanation - Explanatory text.

equal

public static void equal(double reference,
                         double value,
                         double sample,
                         @Nonnull
                         Object explanation)

Requires double equal.

Parameters:

reference - The double reference.

value - The double value.

sample - A sample value.

explanation - Explanatory text.

failure

public static Require.FailureException failure()
                                        throws Require.FailureException

Forces a failure.

Often used in the 'default' clause of a 'switch' instruction.

Returns:

A value to satisfy compiler verifications.

Throws:

Require.FailureException - Without explanatory text.

failure

public static void failure(boolean value)

Failure.

Parameters:

value - The value which must be false.

Throws:

Require.FailureException - Without explanatory text.

failure

public static Require.FailureException failure(@Nonnull
                                               Exception cause)
                                        throws Require.FailureException

Failure.

Parameters:

cause - The failure cause.

Returns:

A value to satisfy compiler verifications.

Throws:

Require.FailureException - Without explanatory text.

failure

public static Require.FailureException failure(@Nonnull
                                               Object explanation)
                                        throws Require.FailureException

Failure.

Parameters:

explanation - Explanatory text.

Returns:

A value to satisfy compiler verifications.

Throws:

Require.FailureException - With explanatory text.

failure

public static void failure(boolean value,
                           @Nonnull
                           Object explanation)

Failure.

Parameters:

value - The value which must be false.

explanation - Explanatory text.

Throws:

Require.FailureException - When the value is true.

failure

public static Require.FailureException failure(@Nonnull
                                               Exception cause,
                                               @Nonnull
                                               Object explanation)
                                        throws Require.FailureException

Failure.

Parameters:

cause - The failure cause.

explanation - Explanatory text.

Returns:

A value to satisfy compiler verifications.

Throws:

Require.FailureException - Without explanatory text.

ignored

public static void ignored(boolean value)

Ignores a boolean value.

Parameters:

value - The value to ignore.

ignored

public static void ignored(double value)

Ignores a double value.

Parameters:

value - The value to ignore.

ignored

public static void ignored(long value)

Ignores a long value.

Parameters:

value - The value to ignore.

ignored

public static void ignored(Object value)

Ignores an object value.

Parameters:

value - The value to ignore.

notEmpty

@Nonnull
public static String notEmpty(@Nullable
                                        String string)
                                 throws Require.FailureException

Requires a not empty string.

Parameters:

string - The tested string.

Returns:

The tested string (may be ignored).

Throws:

Require.FailureException - For null or empty tested string.

notEmptyTrimmed

@Nonnull
 @CheckReturnValue
public static String notEmptyTrimmed(@Nullable
                                                                   String string)
                                                            throws Require.FailureException

Requires a not empty trimmed string.

Parameters:

string - The tested string.

Returns:

The tested string trimmed.

Throws:

Require.FailureException - For null or empty tested string.

notNull

@Nonnull
public static <T> T notNull(@Nullable
                                      T object)
                               throws Require.FailureException

Requires an object.

Type Parameters:

T - The type of the tested object.

Parameters:

object - The tested object.

Returns:

The tested object when not null.

Throws:

Require.FailureException - For null tested object.

notNull

@Nonnull
public static <T> T notNull(@Nullable
                                      T object,
                                      @Nonnull
                                      Object explanation)
                               throws Require.FailureException

Requires an object.

Type Parameters:

T - The type of the tested object.

Parameters:

object - The tested object.

explanation - Explanatory text.

Returns:

The tested object when not null.

Throws:

Require.FailureException - For null tested object.

notPresent

@Nonnull
public static <T> void notPresent(@Nonnull
                                            Optional<T> object)
                                     throws Require.FailureException

Requires an optional object to not be present.

Type Parameters:

T - The type of the tested object.

Parameters:

object - The tested optional object.

Throws:

Require.FailureException - For present tested object.

notPresent

@Nonnull
public static <T> void notPresent(@Nonnull
                                            Optional<T> object,
                                            @Nonnull
                                            Object explanation)
                                     throws Require.FailureException

Requires an optional object to not be present.

Type Parameters:

T - The type of the tested object.

Parameters:

object - The tested optional object.

explanation - Explanatory text.

Throws:

Require.FailureException - For present tested object.

present

@Nonnull
public static <T> void present(@Nonnull
                                         Optional<T> object)
                                  throws Require.FailureException

Requires an optional object to be present.

Type Parameters:

T - The type of the tested object.

Parameters:

object - The tested optional object.

Throws:

Require.FailureException - For non present tested object.

present

@Nonnull
public static <T> void present(@Nonnull
                                         Optional<T> object,
                                         @Nonnull
                                         Object explanation)
                                  throws Require.FailureException

Requires an optional object to be present.

Type Parameters:

T - The type of the tested object.

Parameters:

object - The tested optional object.

explanation - Explanatory text.

Throws:

Require.FailureException - For non present tested object.

same

public static void same(@Nullable
                        Object reference,
                        @Nullable
                        Object value)

Requires the two arguments to be the same object.

Parameters:

reference - The reference object.

value - The value object.

same

public static void same(@Nullable
                        Object reference,
                        @Nullable
                        Object value,
                        @Nonnull
                        Object explanation)

Requires the two arguments to be the same object.

Parameters:

reference - The reference object.

value - The value object.

explanation - Explanatory text.

success

public static boolean success(boolean value)

Requires success.

Parameters:

value - The value which must be true.

Returns:

True.

Throws:

Require.FailureException - When the value is false.

success

public static void success(@Nullable
                           Exception exception)

Requires success.

Parameters:

exception - A possible exception.

Throws:

Require.FailureException - When the exception is not null.

success

public static boolean success(boolean value,
                              @Nonnull
                              Object explanation)

Requires success.

Parameters:

value - The value which must be true.

explanation - Explanatory text.

Returns:

True.

Throws:

Require.FailureException - When the value is false.

success

public static void success(@Nullable
                           Exception exception,
                           @Nonnull
                           Object explanation)

Requires success.

Parameters:

exception - A possible exception.

explanation - Explanatory text.

Throws:

Require.FailureException - When the exception is not null.