net.infumia.frame

Class Preconditions

java.lang.Object

net.infumia.frame.Preconditions

public final class Preconditions
extends java.lang.Object

A utility class for preconditions.

Method Summary

Modifier and Type	Method and Description
static void	argument(boolean check, @NotNull java.lang.String message, java.lang.Object... args) Checks if an argument is null.
static <T> T	argumentNotNull(T object, @NotNull java.lang.String message, java.lang.Object... args) Checks if an argument is not null.
static void	state(boolean check, @NotNull java.lang.String message, java.lang.Object... args) Checks if a state is valid.
static <T> T	stateNotNull(T object, @NotNull java.lang.String message, java.lang.Object... args) Checks if a state is not null.

Methods inherited from class java.lang.Object

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

Method Detail

argument

@Contract(value="false, _, _ -> fail")
public static void argument(boolean check,
                                                                   @NotNull
                                                                   @NotNull java.lang.String message,
                                                                   java.lang.Object... args)

Checks if an argument is null.

Parameters:

check - The check.

message - The message.

args - The arguments.

Throws:

java.lang.IllegalArgumentException - If the check is false.

argumentNotNull

@Contract(value="null, _, _ -> fail")
public static <T> T argumentNotNull(@Nullable
                                                                          T object,
                                                                          @NotNull
                                                                          @NotNull java.lang.String message,
                                                                          java.lang.Object... args)

Checks if an argument is not null.

Parameters:

object - The object.

message - The message.

args - The arguments.

Returns:

The object.

Throws:

java.lang.IllegalArgumentException - If the object is null.

state

@Contract(value="false, _, _ -> fail")
public static void state(boolean check,
                                                                @NotNull
                                                                @NotNull java.lang.String message,
                                                                java.lang.Object... args)

Checks if a state is valid.

Parameters:

check - The check.

message - The message.

args - The arguments.

Throws:

java.lang.IllegalStateException - If the check is false.

stateNotNull

@Contract(value="null, _, _ -> fail")
public static <T> T stateNotNull(@Nullable
                                                                       T object,
                                                                       @NotNull
                                                                       @NotNull java.lang.String message,
                                                                       java.lang.Object... args)

Checks if a state is not null.

Parameters:

object - The object.

message - The message.

args - The arguments.

Returns:

The object.

Throws:

java.lang.IllegalStateException - If the object is null.