net.yetamine.checks.Argument Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of net.yetamine.checks Show documentation
Show all versions of net.yetamine.checks Show documentation
A set of utilities for compact runtime checks.
package net.yetamine.checks;
import java.util.function.Supplier;
/**
* A utility class for checking argument pre-conditions.
*/
public final class Argument {
/**
* Checks an argument whether it satisfies a condition.
*
* @param
* the type of the result
* @param result
* the argument to check and returned
* @param condition
* the condition to check
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static T check(T result, boolean condition) {
if (condition) {
return result;
}
throw new IllegalArgumentException();
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param
* the type of the result
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param message
* the message of the exception thrown when the check fails
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static T check(T result, boolean condition, String message) {
if (condition) {
return result;
}
throw new IllegalArgumentException(message);
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param
* the type of the result
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param messageSupplier
* the supplier of the message for the exception that is thrown
* when the check fails. It must not be {@code null}.
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static T check(T result, boolean condition, Supplier messageSupplier) {
assert (messageSupplier != null) : "Message supplier must not be null.";
if (condition) {
return result;
}
throw new IllegalArgumentException(messageSupplier.get());
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static char check(char result, boolean condition) {
if (condition) {
return result;
}
throw new IllegalArgumentException();
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param message
* the message of the exception thrown when the check fails
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static char check(char result, boolean condition, String message) {
if (condition) {
return result;
}
throw new IllegalArgumentException(message);
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param messageSupplier
* the supplier of the message for the exception that is thrown
* when the check fails. It must not be {@code null}.
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static char check(char result, boolean condition, Supplier messageSupplier) {
assert (messageSupplier != null) : "Message supplier must not be null.";
if (condition) {
return result;
}
throw new IllegalArgumentException(messageSupplier.get());
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static byte check(byte result, boolean condition) {
if (condition) {
return result;
}
throw new IllegalArgumentException();
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param message
* the message of the exception thrown when the check fails
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static byte check(byte result, boolean condition, String message) {
if (condition) {
return result;
}
throw new IllegalArgumentException(message);
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param messageSupplier
* the supplier of the message for the exception that is thrown
* when the check fails. It must not be {@code null}.
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static byte check(byte result, boolean condition, Supplier messageSupplier) {
assert (messageSupplier != null) : "Message supplier must not be null.";
if (condition) {
return result;
}
throw new IllegalArgumentException(messageSupplier.get());
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static short check(short result, boolean condition) {
if (condition) {
return result;
}
throw new IllegalArgumentException();
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param message
* the message of the exception thrown when the check fails
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static short check(short result, boolean condition, String message) {
if (condition) {
return result;
}
throw new IllegalArgumentException(message);
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param messageSupplier
* the supplier of the message for the exception that is thrown
* when the check fails. It must not be {@code null}.
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static short check(short result, boolean condition, Supplier messageSupplier) {
assert (messageSupplier != null) : "Message supplier must not be null.";
if (condition) {
return result;
}
throw new IllegalArgumentException(messageSupplier.get());
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static int check(int result, boolean condition) {
if (condition) {
return result;
}
throw new IllegalArgumentException();
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param message
* the message of the exception thrown when the check fails
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static int check(int result, boolean condition, String message) {
if (condition) {
return result;
}
throw new IllegalArgumentException(message);
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param messageSupplier
* the supplier of the message for the exception that is thrown
* when the check fails. It must not be {@code null}.
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static int check(int result, boolean condition, Supplier messageSupplier) {
assert (messageSupplier != null) : "Message supplier must not be null.";
if (condition) {
return result;
}
throw new IllegalArgumentException(messageSupplier.get());
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static long check(long result, boolean condition) {
if (condition) {
return result;
}
throw new IllegalArgumentException();
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param message
* the message of the exception thrown when the check fails
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static long check(long result, boolean condition, String message) {
if (condition) {
return result;
}
throw new IllegalArgumentException(message);
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param messageSupplier
* the supplier of the message for the exception that is thrown
* when the check fails. It must not be {@code null}.
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static long check(long result, boolean condition, Supplier messageSupplier) {
assert (messageSupplier != null) : "Message supplier must not be null.";
if (condition) {
return result;
}
throw new IllegalArgumentException(messageSupplier.get());
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static float check(float result, boolean condition) {
if (condition) {
return result;
}
throw new IllegalArgumentException();
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param message
* the message of the exception thrown when the check fails
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static float check(float result, boolean condition, String message) {
if (condition) {
return result;
}
throw new IllegalArgumentException(message);
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param messageSupplier
* the supplier of the message for the exception that is thrown
* when the check fails. It must not be {@code null}.
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static float check(float result, boolean condition, Supplier messageSupplier) {
assert (messageSupplier != null) : "Message supplier must not be null.";
if (condition) {
return result;
}
throw new IllegalArgumentException(messageSupplier.get());
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static double check(double result, boolean condition) {
if (condition) {
return result;
}
throw new IllegalArgumentException();
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param message
* the message of the exception thrown when the check fails
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static double check(double result, boolean condition, String message) {
if (condition) {
return result;
}
throw new IllegalArgumentException(message);
}
/**
* Checks an argument whether it satisfies a condition.
*
* @param result
* the argument to check and returned
* @param condition
* the condition to check
* @param messageSupplier
* the supplier of the message for the exception that is thrown
* when the check fails. It must not be {@code null}.
*
* @return the argument to check
*
* @throws IllegalArgumentException
* if the condition is not satisfied
*/
public static double check(double result, boolean condition, Supplier messageSupplier) {
assert (messageSupplier != null) : "Message supplier must not be null.";
if (condition) {
return result;
}
throw new IllegalArgumentException(messageSupplier.get());
}
private Argument() {
throw new AssertionError();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy