Module org.tquadrat.foundation.util

Package org.tquadrat.foundation.util

Class RangeFunctions

java.lang.Object

org.tquadrat.foundation.util.RangeFunctions

@UtilityClass
@ClassVersion(sourceVersion="$Id: RangeFunctions.java 1032 2022-04-10 17:27:44Z tquadrat $")
@API(status=STABLE,
     since="0.0.7")
public final class RangeFunctions
extends Object

Several range checking functions.

The functions in this class support range checking for various types. This can be especially useful for scripting, but is also usable in other contexts.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Thanks to:

Ben Gidley

Version:

$Id: RangeFunctions.java 1032 2022-04-10 17:27:44Z tquadrat $

Since:

0.0.7

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.util.RangeFunctions"

⁠

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RangeFunctions()	No instance is allowed for this class.

Method Summary

Modifier and Type	Method	Description
static boolean	isAbove(char value, char floor)	Returns true if value is above floor.
static boolean	isAbove(double value, double floor)	Returns true if value is above floor.
static boolean	isAbove(long value, long floor)	Returns true if value is above floor.
static <T> boolean	isAbove(Comparable<T> value, T floor)	Returns true if value is above floor.
static <T> boolean	isAbove(Comparable<T> value, T floor, boolean include)	Returns true if value is above floor.
static <T> boolean	isAbove(Comparator<T> comparator, T value, T floor)	Returns true if value is above floor.
static <T> boolean	isAbove(Comparator<T> comparator, T value, T floor, boolean include)	Returns true if value is above floor.
static boolean	isBelow(char value, char ceiling)	Returns true if value is below ceiling.
static boolean	isBelow(double value, double ceiling)	Returns true if value is below ceiling.
static boolean	isBelow(long value, long ceiling)	Returns true if value is below ceiling.
static <T> boolean	isBelow(Comparable<T> value, T ceiling)	Returns true if value is below ceiling.
static <T> boolean	isBelow(Comparable<T> value, T ceiling, boolean include)	Returns true if value is below ceiling.
static <T> boolean	isBelow(Comparator<T> comparator, T value, T ceiling)	Returns true if value is below ceiling.
static <T> boolean	isBelow(Comparator<T> comparator, T value, T ceiling, boolean include)	Returns true if value is below ceiling.
static boolean	isBetween(char value, char floor, char ceiling)	Returns true if value is between floor and ceiling.
static boolean	isBetween(char value, char floor, char ceiling, boolean include)	Returns true if value is between floor and ceiling.
static boolean	isBetween(double value, double floor, double ceiling)	Returns true if value is between floor and ceiling.
static boolean	isBetween(double value, double floor, double ceiling, boolean include)	Returns true if value is between floor and ceiling.
static boolean	isBetween(long value, long floor, long ceiling)	Returns true if value is between floor and ceiling.
static boolean	isBetween(long value, long floor, long ceiling, boolean include)	Returns true if value is between floor and ceiling.
static <T> boolean	isBetween(Comparable<T> value, T floor, T ceiling)	Returns true if value is between floor and ceiling.
static <T> boolean	isBetween(Comparable<T> value, T floor, T ceiling, boolean include)	Returns true if value is between floor and ceiling.
static <T> boolean	isBetween(Comparator<T> comparator, T value, T floor, T ceiling)	Returns true if value is between floor and ceiling.
static <T> boolean	isBetween(Comparator<T> comparator, T value, T floor, T ceiling, boolean include)	Returns true if value is between floor and ceiling.

Methods inherited from class java.lang.Object

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

Constructor Details

RangeFunctions

private RangeFunctions()

No instance is allowed for this class.

Method Details

isAbove

public static <T> boolean isAbove(Comparable<T> value,
 T floor,
 boolean include)

Returns true if value is above floor.

Type Parameters:

T - The type of the values to check.

Parameters:

value - The value to compare.

floor - The border value.

include - true if the border is included, false if not.

Returns:

true if the given value is greater than the given border value, false otherwise. If include is true, it will be "greater or equal", respectively.

isAbove

public static <T> boolean isAbove(Comparator<T> comparator,
 T value,
 T floor,
 boolean include)

Returns true if value is above floor.

Type Parameters:

T - The type of the values to check.

Parameters:

comparator - The comparator that is used for the comparison.

value - The value to compare.

floor - The border value.

include - true if the border is included, false if not.

Returns:

true if the given value is greater than the given border value, false otherwise. If include is true, it will be "greater or equal", respectively.

isAbove

public static <T> boolean isAbove(Comparable<T> value,
 T floor)

Returns true if value is above floor. If include is true, floor is included, otherwise it is not part of the range.

Type Parameters:

T - The type of the values to check.

Parameters:

value - The value to compare.

floor - The border value.

Returns:

true if the given value is greater than the given border value, false otherwise.

isAbove

public static <T> boolean isAbove(Comparator<T> comparator,
 T value,
 T floor)

Returns true if value is above floor. If include is true, floor is included, otherwise it is not part of the range.

Type Parameters:

T - The type of the values to check.

Parameters:

comparator - The comparator that is used for the comparison.

value - The value to compare.

floor - The border value.

Returns:

true if the given value is greater than the given border value, false otherwise.

isAbove

public static boolean isAbove(char value,
 char floor)

Returns true if value is above floor.

Parameters:

value - The value to compare.

floor - The border value.

Returns:

true if the given value is greater than the given border value, false otherwise.

isAbove

public static boolean isAbove(double value,
 double floor)

Returns true if value is above floor.

Parameters:

value - The value to compare.

floor - The border value.

Returns:

true if the given value is greater than the given border value, false otherwise.

isAbove

public static boolean isAbove(long value,
 long floor)

Returns true if value is above floor.

Parameters:

value - The value to compare.

floor - The border value.

Returns:

true if the given value is greater than the given border value, false otherwise.

isBelow

public static <T> boolean isBelow(Comparable<T> value,
 T ceiling,
 boolean include)

Returns true if value is below ceiling. If include is true, ceiling is included, otherwise it is not part of the range.

Type Parameters:

T - The type of the values to check.

Parameters:

value - The value to compare.

ceiling - The border value.

include - true if the border is included, false if not.

Returns:

true if the given value is less than the given border value, false otherwise. If include is true, it will be "less or equal", respectively.

isBelow

public static <T> boolean isBelow(Comparator<T> comparator,
 T value,
 T ceiling,
 boolean include)

Returns true if value is below ceiling. If include is true, ceiling is included, otherwise it is not part of the range.

Type Parameters:

T - The type of the values to check.

Parameters:

comparator - The comparator that is used for the comparison.

value - The value to compare.

ceiling - The border value.

include - true if the border is included, false if not.

Returns:

true if the given value is less than the given border value, false otherwise. If include is true, it will be "less or equal", respectively.

isBelow

public static <T> boolean isBelow(Comparable<T> value,
 T ceiling)

Returns true if value is below ceiling.

Type Parameters:

T - The type of the values to check.

Parameters:

value - The value to compare.

ceiling - The border value.

Returns:

true if the given value is less than the given border value, false otherwise.

isBelow

public static <T> boolean isBelow(Comparator<T> comparator,
 T value,
 T ceiling)

Returns true if value is below ceiling.

Type Parameters:

T - The type of the values to check.

Parameters:

comparator - The comparator that is used for the comparison.

value - The value to compare.

ceiling - The border value.

Returns:

true if the given value is less than the given border value, false otherwise.

isBelow

public static boolean isBelow(char value,
 char ceiling)

Returns true if value is below ceiling.

Parameters:

value - The value to compare.

ceiling - The border value.

Returns:

true if the given value is less than the given border value, false otherwise.

isBelow

public static boolean isBelow(double value,
 double ceiling)

Returns true if value is below ceiling.

Parameters:

value - The value to compare.

ceiling - The border value.

Returns:

true if the given value is less than the given border value, false otherwise.

isBelow

public static boolean isBelow(long value,
 long ceiling)

Returns true if value is below ceiling.

Parameters:

value - The value to compare.

ceiling - The border value.

Returns:

true if the given value is less than the given border value, false otherwise.

isBetween

public static <T> boolean isBetween(Comparable<T> value,
 T floor,
 T ceiling,
 boolean include)

Returns true if value is between floor and ceiling. If include is true, floor and ceiling are included, otherwise they are not in the range.

Type Parameters:

T - The type of the values to check.

Parameters:

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

include - true if the borders are included, false if not.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise. If include is true, it will be "greater or equal" and "less or equal", respectively.

isBetween

public static <T> boolean isBetween(Comparator<T> comparator,
 T value,
 T floor,
 T ceiling,
 boolean include)

Returns true if value is between floor and ceiling. If include is true, floor and ceiling are included, otherwise they are not in the range.

Type Parameters:

T - The type of the values to check.

Parameters:

comparator - The comparator that is used for the comparison.

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

include - true if the borders are included, false if not.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise. If include is true, it will be "greater or equal" and "less or equal", respectively.

isBetween

public static boolean isBetween(char value,
 char floor,
 char ceiling,
 boolean include)

Returns true if value is between floor and ceiling. If include is true, floor and ceiling are included, otherwise they are not in the range.

Parameters:

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

include - true if the borders are included, false if not.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise. If include is true, it will be "greater or equal" and "less or equal", respectively.

isBetween

public static boolean isBetween(double value,
 double floor,
 double ceiling,
 boolean include)

Returns true if value is between floor and ceiling. If include is true, floor and ceiling are included, otherwise they are not in the range.

Parameters:

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

include - true if the borders are included, false if not.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise. If include is true, it will be "greater or equal" and "less or equal", respectively.

isBetween

public static boolean isBetween(long value,
 long floor,
 long ceiling,
 boolean include)

Returns true if value is between floor and ceiling. If include is true, floor and ceiling are included, otherwise they are not in the range.

Parameters:

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

include - true if the borders are included, false if not.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise. If include is true, it will be "greater or equal" and "less or equal", respectively.

isBetween

public static <T> boolean isBetween(Comparable<T> value,
 T floor,
 T ceiling)

Returns true if value is between floor and ceiling.

Type Parameters:

T - The type of the values to check.

Parameters:

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise.

isBetween

public static <T> boolean isBetween(Comparator<T> comparator,
 T value,
 T floor,
 T ceiling)

Returns true if value is between floor and ceiling.

Type Parameters:

T - The type of the values to check.

Parameters:

comparator - The comparator that is used for the comparison.

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise.

isBetween

public static boolean isBetween(char value,
 char floor,
 char ceiling)

Returns true if value is between floor and ceiling.

Parameters:

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise.

isBetween

public static boolean isBetween(double value,
 double floor,
 double ceiling)

Returns true if value is between floor and ceiling.

Parameters:

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise.

isBetween

public static boolean isBetween(long value,
 long floor,
 long ceiling)

Returns true if value is between floor and ceiling.

Parameters:

value - The value to compare.

floor - The lower border value.

ceiling - The upper border value.

Returns:

true if the given value is greater than the given lower border value and less than the given upper border value, false otherwise.