org.fujion.common

Class Assert

java.lang.Object

org.fujion.common.Assert

public class Assert
extends Object

Assertion methods.

Constructor Summary

Constructors

Constructor and Description
Assert()

Method Summary

Modifier and Type	Method and Description
static <T> T	fail(String message, Object... params) Always fails, throwing an IllegalArgument Exception.
static <T> T	fail(Supplier<String> message, Object... params) Always fails, throwing an IllegalArgument Exception.
static void	isFalse(boolean condition, String message, Object... params) Asserts that a condition is false, throwing an IllegalArgumentException if not.
static void	isFalse(boolean condition, Supplier<String> message, Object... params) Asserts that a tested condition is false, throwing an IllegalArgumentException if not.
static void	isNull(Object value, String message, Object... params) Asserts that a value is null, throwing an IllegalArgumentException if not.
static void	isNull(Object value, Supplier<String> message, Object... params) Asserts that a value is null, throwing an IllegalArgumentException if not.
static void	isTrue(boolean condition, String message, Object... params) Asserts that a condition is true, throwing an IllegalArgumentException if not.
static void	isTrue(boolean condition, Supplier<String> message, Object... params) Asserts that a tested condition is true, throwing an IllegalArgumentException if not.
static void	notNull(Object value, String message, Object... params) Asserts that a value is not null, throwing an IllegalArgumentException if it is.
static void	notNull(Object value, Supplier<String> message, Object... params) Asserts that a value is not null, throwing an IllegalArgumentException if it is.
static void	state(boolean state, String message, Object... params) Asserts that a tested state is true, throwing an IllegalStateException if not.
static void	state(boolean state, Supplier<String> message, Object... params) Asserts that a tested state is true, throwing an IllegalStateException if not.

Methods inherited from class java.lang.Object

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

Constructor Detail

Assert

public Assert()

Method Detail

fail

public static <T> T fail(String message,
                         Object... params)

Always fails, throwing an IllegalArgument Exception.

Type Parameters:

T - Pseudo return type to allow use as function.

Parameters:

message - The exception message.

params - Optional parameters if formatted message.

Returns:

Never returns a value.

Throws:

IllegalArgumentException - always thrown.

fail

public static <T> T fail(Supplier<String> message,
                         Object... params)

Always fails, throwing an IllegalArgument Exception.

Type Parameters:

T - Pseudo return type to allow use as function.

Parameters:

message - The exception message.

params - Optional parameters if formatted message.

Returns:

Never returns a value.

Throws:

IllegalArgumentException - always thrown.

isTrue

public static void isTrue(boolean condition,
                          String message,
                          Object... params)

Asserts that a condition is true, throwing an IllegalArgumentException if not.

Parameters:

condition - The condition to test.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalArgumentException - if condition is false.

isTrue

public static void isTrue(boolean condition,
                          Supplier<String> message,
                          Object... params)

Asserts that a tested condition is true, throwing an IllegalArgumentException if not.

Parameters:

condition - The tested condition.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalArgumentException - if condition is false.

isFalse

public static void isFalse(boolean condition,
                           String message,
                           Object... params)

Asserts that a condition is false, throwing an IllegalArgumentException if not.

Parameters:

condition - The condition to test.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalArgumentException - if condition is true.

isFalse

public static void isFalse(boolean condition,
                           Supplier<String> message,
                           Object... params)

Asserts that a tested condition is false, throwing an IllegalArgumentException if not.

Parameters:

condition - The tested condition.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalArgumentException - if condition is true.

isNull

public static void isNull(Object value,
                          String message,
                          Object... params)

Asserts that a value is null, throwing an IllegalArgumentException if not.

Parameters:

value - The value to check.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalArgumentException - if value is not null.

isNull

public static void isNull(Object value,
                          Supplier<String> message,
                          Object... params)

Asserts that a value is null, throwing an IllegalArgumentException if not.

Parameters:

value - The value to check.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalArgumentException - if value is not null.

notNull

public static void notNull(Object value,
                           String message,
                           Object... params)

Asserts that a value is not null, throwing an IllegalArgumentException if it is.

Parameters:

value - The value to check.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalArgumentException - if value is null.

notNull

public static void notNull(Object value,
                           Supplier<String> message,
                           Object... params)

Asserts that a value is not null, throwing an IllegalArgumentException if it is.

Parameters:

value - The value to check.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalArgumentException - if value is null.

state

public static void state(boolean state,
                         String message,
                         Object... params)

Asserts that a tested state is true, throwing an IllegalStateException if not.

Parameters:

state - The tested state.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalStateException - if state is false.

state

public static void state(boolean state,
                         Supplier<String> message,
                         Object... params)

Asserts that a tested state is true, throwing an IllegalStateException if not.

Parameters:

state - The tested state.

message - The exception message.

params - Optional parameters if formatted message.

Throws:

IllegalStateException - if state is false.