com.googlecode.kevinarpe.papaya.argument.ComparableArgs Maven / Gradle / Ivy
package com.googlecode.kevinarpe.papaya.argument;
import com.googlecode.kevinarpe.papaya.annotation.FullyTested;
/*
* #%L
* This file is part of Papaya.
* %%
* Copyright (C) 2013 - 2014 Kevin Connor ARPE ([email protected])
* %%
* Papaya is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* GPL Classpath Exception:
* This project is subject to the "Classpath" exception as provided in
* the LICENSE file that accompanied this code.
*
* Papaya is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Papaya. If not, see
* See {@link ObjectArgs} for an overview.
*
* @author Kevin Connor ARPE ([email protected])
*/
@FullyTested
public final class ComparableArgs {
// Disable default constructor
private ComparableArgs() {
}
/**
* Tests if a Comparable reference is not null and its value within specified range.
*
* @param ref
* an object reference
* @param minValue
* minimum value (inclusive)
* @param maxValue
* maximum value (inclusive)
* @param argName
* argument name for {@code ref}, e.g., "strList" or "searchRegex"
*
* @return the validated object reference
*
* @throws NullPointerException
* if {@code ref}, {@code minValue}, or {@code maxValue} is
* {@code null}
* @throws IllegalArgumentException
*
* - if {@code minValue > maxValue}
* - if value of {@code ref} is outside allowed range
*
*
* @see ObjectArgs#checkNotNull(Object, String)
* @see #checkMinValue(Comparable, Comparable, String)
* @see #checkMaxValue(Comparable, Comparable, String)
* @see #checkExactValue(Comparable, Comparable, String)
*/
@FullyTested
public static > T checkValueRange(
T ref, T minValue, T maxValue, String argName) {
ObjectArgs.checkNotNull(minValue, "minValue");
ObjectArgs.checkNotNull(maxValue, "maxValue");
_checkRangeCore(ref, minValue, maxValue, argName);
return ref;
}
/**
* Tests if a Comparable reference is not null and its value within specified range.
*
* @param ref
* an object reference
* @param minRangeValue
* minimum value (inclusive)
* @param maxRangeValue
* maximum value (inclusive)
* @param argName
* argument name for {@code ref}, e.g., "strList" or "searchRegex"
*
* @return the validated object reference
*
* @throws NullPointerException
* if {@code ref}, {@code minValue}, or {@code maxValue} is
* {@code null}
* @throws IllegalArgumentException
*
* - if {@code minValue > maxValue}
* - if value of {@code ref} is outside allowed range
*
*
* @see ObjectArgs#checkNotNull(Object, String)
* @see #checkValueOutsideRange(Comparable, Comparable, Comparable, String)
* @see #checkMinValue(Comparable, Comparable, String)
* @see #checkMaxValue(Comparable, Comparable, String)
* @see #checkExactValue(Comparable, Comparable, String)
* @see #checkNotExactValue(Comparable, Comparable, String)
*/
public static > T checkValueInsideRange(
T ref, T minRangeValue, T maxRangeValue, String argName) {
ObjectArgs.checkNotNull(ref, "ref");
_checkMinAndMaxRangeValues(minRangeValue, maxRangeValue, argName);
if (ref.compareTo(minRangeValue) < 0 || ref.compareTo(maxRangeValue) > 0) {
final String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': Value outside valid range: (min) %s <= %s <= %s (max)%s",
argName, minRangeValue, ref, maxRangeValue, w));
}
return ref;
}
/**
* Tests if a Comparable reference is not null and its value not within specified range.
*
* @param ref
* an object reference
* @param minRangeValue
* minimum value (inclusive)
* @param maxRangeValue
* maximum value (inclusive)
* @param argName
* argument name for {@code ref}, e.g., "strList" or "searchRegex"
*
* @return the validated object reference
*
* @throws NullPointerException
* if {@code ref}, {@code minValue}, or {@code maxValue} is
* {@code null}
* @throws IllegalArgumentException
*
* - if {@code minValue > maxValue}
* - if value of {@code ref} is outside allowed range
*
*
* @see ObjectArgs#checkNotNull(Object, String)
* @see #checkValueInsideRange(Comparable, Comparable, Comparable, String)
* @see #checkMinValue(Comparable, Comparable, String)
* @see #checkMaxValue(Comparable, Comparable, String)
* @see #checkExactValue(Comparable, Comparable, String)
* @see #checkNotExactValue(Comparable, Comparable, String)
*/
public static > T checkValueOutsideRange(
T ref, T minRangeValue, T maxRangeValue, String argName) {
ObjectArgs.checkNotNull(ref, "ref");
_checkMinAndMaxRangeValues(minRangeValue, maxRangeValue, argName);
if (ref.compareTo(minRangeValue) >= 0 && ref.compareTo(maxRangeValue) <= 0) {
final String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': Value inside invalid range: (min) %s >= %s <= %s (max)%s",
argName, minRangeValue, ref, maxRangeValue, w));
}
return ref;
}
private static > void _checkMinAndMaxRangeValues(
T minRangeValue, T maxRangeValue, String argName) {
ObjectArgs.checkNotNull(minRangeValue, "minRangeValue");
ObjectArgs.checkNotNull(maxRangeValue, "maxRangeValue");
if (minRangeValue.compareTo(maxRangeValue) > 0) {
final String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': 'minRangeValue' > 'maxRangeValue': %s > %s%s",
argName, minRangeValue, maxRangeValue, w));
}
}
private static > void _checkRangeCore(
T ref, T optMinValue, T optMaxValue, String argName) {
ObjectArgs.checkNotNull(ref, argName);
if (null != optMinValue && null != optMaxValue && optMinValue.compareTo(optMaxValue) > 0) {
String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': 'minValue' > 'maxValue': %s > %s%s",
argName, optMinValue, optMaxValue, w));
}
if (null != optMinValue && ref.compareTo(optMinValue) < 0) {
String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': value < 'minValue': %s < %s%s",
argName, ref, optMinValue, w));
}
if (null != optMaxValue && ref.compareTo(optMaxValue) > 0) {
String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': value > 'maxValue': %s > %s%s",
argName, ref, optMaxValue, w));
}
}
/**
* Tests if a Comparable reference is not null and has a minimum value.
*
* @param ref
* an object reference
* @param minValue
* minimum value (inclusive)
* @param argName
* argument name for {@code ref}, e.g., "strList" or "searchRegex"
*
* @return the validated object reference
*
* @throws NullPointerException
* if {@code ref} or {@code minValue} is {@code null}
* @throws IllegalArgumentException
* if value of {@code ref} is outside allowed range
*
* @see #checkValueRange(Comparable, Comparable, Comparable, String)
*/
@FullyTested
public static > T checkMinValue(
T ref, T minValue, String argName) {
ObjectArgs.checkNotNull(minValue, "minValue");
T maxValue = null;
_checkRangeCore(ref, minValue, maxValue, argName);
return ref;
}
/**
* Tests if a Comparable reference is not null and has a maximum value.
*
* @param ref
* an object reference
* @param maxValue
* maximum value (inclusive)
* @param argName
* argument name for {@code ref}, e.g., "strList" or "searchRegex"
*
* @return the validated object reference
*
* @throws NullPointerException
* if {@code ref} or {@code maxValue} is {@code null}
* @throws IllegalArgumentException
* if value of {@code ref} is outside allowed range
*
* @see #checkValueRange(Comparable, Comparable, Comparable, String)
*/
@FullyTested
public static > T checkMaxValue(
T ref, T maxValue, String argName) {
ObjectArgs.checkNotNull(maxValue, "maxValue");
T minValue = null;
_checkRangeCore(ref, minValue, maxValue, argName);
return ref;
}
/**
* Tests if a Comparable reference is not null and has an exact value.
*
* @param ref
* an object reference
* @param exactValue
* expected value
* @param argName
* argument name for {@code ref}, e.g., "strList" or "searchRegex"
*
* @return the validated object reference
*
* @throws NullPointerException
* if {@code ref} or {@code exactValue} is {@code null}
* @throws IllegalArgumentException
* if value of {@code ref} is not the exact value
*
* @see #checkValueRange(Comparable, Comparable, Comparable, String)
*/
@FullyTested
public static > T checkExactValue(
T ref, T exactValue, String argName) {
ObjectArgs.checkNotNull(ref, argName);
ObjectArgs.checkNotNull(exactValue, "exactValue");
if (0 != ref.compareTo(exactValue)) {
String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': 'ref' != 'exactValue': %s != %s%s",
argName, ref, exactValue, w));
}
return ref;
}
/**
* Tests if a Comparable reference is not null and is not an exact value.
*
* @param ref
* an object reference
* @param exactValue
* unexpected value
* @param argName
* argument name for {@code ref}, e.g., "strList" or "searchRegex"
*
* @return the validated object reference
*
* @throws NullPointerException
* if {@code ref} or {@code exactValue} is {@code null}
* @throws IllegalArgumentException
* if value of {@code ref} is the exact value
*
* @see #checkValueRange(Comparable, Comparable, Comparable, String)
*/
@FullyTested
public static > T checkNotExactValue(
T ref, T exactValue, String argName) {
ObjectArgs.checkNotNull(ref, argName);
ObjectArgs.checkNotNull(exactValue, "exactValue");
if (0 == ref.compareTo(exactValue)) {
String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': 'ref' == 'exactValue': %s == %s%s",
argName, ref, exactValue, w));
}
return ref;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy