org.macroing.cit.java.util

Class Objects2

java.lang.Object

org.macroing.cit.java.util.Objects2

public final class Objects2
extends java.lang.Object

A class that consists exclusively of static methods that performs various operations on ranges.

Since:

1.0.0

Author:

Jörgen Lundgren

Method Summary

Modifier and Type	Method and Description
static boolean	equalsIgnoreCase(java.lang.String string, java.lang.String... alternatives) Checks if string is equal to, ignoring case, any of the Strings in alternatives.
static <T> java.lang.String	optional(java.lang.String left, java.lang.String right, java.lang.String separator, java.util.List<?> objects)
static java.lang.String	optional(java.lang.String left, java.lang.String right, java.lang.String separator, java.lang.Object... objects)
static java.lang.String	repeat(java.lang.String string, int repetition) Returns a String that consists of string repeated repetition times.
static <T> T[]	requireDeepNonNull(T[] objects)
static <T> T[]	requireDeepNonNull(T[] objects, java.lang.String name)
static byte	requireRange(byte value, byte minimum, byte maximum) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static byte	requireRange(byte value, byte minimum, byte maximum, java.lang.String name) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static char	requireRange(char value, char minimum, char maximum) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static char	requireRange(char value, char minimum, char maximum, java.lang.String name) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static double	requireRange(double value, double minimum, double maximum) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static double	requireRange(double value, double minimum, double maximum, java.lang.String name) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static float	requireRange(float value, float minimum, float maximum) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static float	requireRange(float value, float minimum, float maximum, java.lang.String name) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static int[]	requireRange(int[] array, int minimum, int maximum) Returns array, but only if its elements are within the range of minimum (inclusive) and maximum (inclusive).
static int	requireRange(int value, int minimum, int maximum) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static int	requireRange(int value, int minimum, int maximum, java.lang.String name) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static long	requireRange(long value, long minimum, long maximum) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static long	requireRange(long value, long minimum, long maximum, java.lang.String name) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static short	requireRange(short value, short minimum, short maximum) Checks that the specified value is within a given closed range, such as [minimum, maximum].
static short	requireRange(short value, short minimum, short maximum, java.lang.String name) Checks that the specified value is within a given closed range, such as [minimum, maximum].

Methods inherited from class java.lang.Object

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

Method Detail

equalsIgnoreCase

public static boolean equalsIgnoreCase(java.lang.String string,
                                       java.lang.String... alternatives)

Checks if string is equal to, ignoring case, any of the Strings in alternatives.

Returns true if, and only if, string is equal to, ignoring case, any of the Strings in alternatives, false otherwise.

If either string or alternatives are null, a NullPointerException will be thrown.

Parameters:

string - the String to check

alternatives - an array of alternative Strings

Returns:

true if, and only if, string is equal to, ignoring case, any of the Strings in alternatives, false otherwise

Throws:

java.lang.NullPointerException - thrown if, and only if, either string or alternatives are null

requireRange

public static byte requireRange(byte value,
                                byte minimum,
                                byte maximum)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

This method is implemented in terms of requireRange(byte, byte, byte, String), with a name of "value".

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

requireRange

public static byte requireRange(byte value,
                                byte minimum,
                                byte maximum,
                                java.lang.String name)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

If name is null, a NullPointerException will be thrown.

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

name - the name of the value, that will be part of the message to the IllegalArgumentException, if thrown

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

java.lang.NullPointerException - thrown if, and only if, name is null

requireRange

public static char requireRange(char value,
                                char minimum,
                                char maximum)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

This method is implemented in terms of requireRange(char, char, char, String), with a name of "value".

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

requireRange

public static char requireRange(char value,
                                char minimum,
                                char maximum,
                                java.lang.String name)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

If name is null, a NullPointerException will be thrown.

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

name - the name of the value, that will be part of the message to the IllegalArgumentException, if thrown

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

java.lang.NullPointerException - thrown if, and only if, name is null

requireRange

public static double requireRange(double value,
                                  double minimum,
                                  double maximum)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

This method is implemented in terms of requireRange(double, double, double, String), with a name of "value".

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

requireRange

public static double requireRange(double value,
                                  double minimum,
                                  double maximum,
                                  java.lang.String name)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

If name is null, a NullPointerException will be thrown.

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

name - the name of the value, that will be part of the message to the IllegalArgumentException, if thrown

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

java.lang.NullPointerException - thrown if, and only if, name is null

requireRange

public static float requireRange(float value,
                                 float minimum,
                                 float maximum)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

This method is implemented in terms of requireRange(float, float, float, String), with a name of "value".

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

requireRange

public static float requireRange(float value,
                                 float minimum,
                                 float maximum,
                                 java.lang.String name)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

If name is null, a NullPointerException will be thrown.

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

name - the name of the value, that will be part of the message to the IllegalArgumentException, if thrown

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

java.lang.NullPointerException - thrown if, and only if, name is null

requireRange

public static int requireRange(int value,
                               int minimum,
                               int maximum)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

This method is implemented in terms of requireRange(int, int, int, String), with a name of "value".

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

requireRange

public static int requireRange(int value,
                               int minimum,
                               int maximum,
                               java.lang.String name)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

If name is null, a NullPointerException will be thrown.

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

name - the name of the value, that will be part of the message to the IllegalArgumentException, if thrown

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

java.lang.NullPointerException - thrown if, and only if, name is null

requireRange

public static int[] requireRange(int[] array,
                                 int minimum,
                                 int maximum)

Returns array, but only if its elements are within the range of minimum (inclusive) and maximum (inclusive).

If one or more of its elements are not within said range, an IllegalArgumentException will be thrown.

If array is null, a NullPointerException will be thrown.

Parameters:

array - the array with elements to verify

minimum - the minimum value allowed (inclusive)

maximum - the maximum value allowed (inclusive)

Returns:

array, but only if its elements are within the range of minimum (inclusive) and maximum (inclusive)

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, array contains an element that is less than minimum or greater than maximum

java.lang.NullPointerException - thrown if, and only if, array is null

requireRange

public static long requireRange(long value,
                                long minimum,
                                long maximum)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

This method is implemented in terms of requireRange(long, long, long, String), with a name of "value".

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

requireRange

public static long requireRange(long value,
                                long minimum,
                                long maximum,
                                java.lang.String name)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

If name is null, a NullPointerException will be thrown.

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

name - the name of the value, that will be part of the message to the IllegalArgumentException, if thrown

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

java.lang.NullPointerException - thrown if, and only if, name is null

requireRange

public static short requireRange(short value,
                                 short minimum,
                                 short maximum)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

This method is implemented in terms of requireRange(short, short, short, String), with a name of "value".

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

requireRange

public static short requireRange(short value,
                                 short minimum,
                                 short maximum,
                                 java.lang.String name)

Checks that the specified value is within a given closed range, such as [minimum, maximum].

Returns the value itself.

If value is less than minimum or greater than maximum, an IllegalArgumentException will be thrown.

If name is null, a NullPointerException will be thrown.

Parameters:

value - the value to check

minimum - the minimum (inclusive) bound of the range

maximum - the maximum (inclusive) bound of the range

name - the name of the value, that will be part of the message to the IllegalArgumentException, if thrown

Returns:

the value itself

Throws:

java.lang.IllegalArgumentException - thrown if, and only if, value is less than minimum or greater than maximum

java.lang.NullPointerException - thrown if, and only if, name is null

optional

public static java.lang.String optional(java.lang.String left,
                                        java.lang.String right,
                                        java.lang.String separator,
                                        java.lang.Object... objects)

optional

public static <T> java.lang.String optional(java.lang.String left,
                                            java.lang.String right,
                                            java.lang.String separator,
                                            java.util.List<?> objects)

repeat

public static java.lang.String repeat(java.lang.String string,
                                      int repetition)

Returns a String that consists of string repeated repetition times.

If string is null, the String literal "null" will be repeated repetition times.

If repetition is less than or equal to 0, an empty String will be returned.

Parameters:

string - the String to repeat

repetition - how many times string should be repeated

Returns:

a String that consists of string repeated repetition times

requireDeepNonNull

public static <T> T[] requireDeepNonNull(T[] objects)

requireDeepNonNull

public static <T> T[] requireDeepNonNull(T[] objects,
                                         java.lang.String name)