com.googlecode.kevinarpe.papaya.argument.LongArgs 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 LongArgs {
// Disable default constructor
private LongArgs() {
}
/**
* Tests if {@code value > 0}
*
* @param value
* a value to test
* @param argName
* argument name for {@code value}, e.g., "strListSize" or "searchRegexLength"
*
* @return the validated value
*
* @throws IllegalArgumentException
* if {@code value <= 0}
*
* @see #checkNotPositive(long, String)
* @see #checkNegative(long, String)
* @see #checkNotNegative(long, String)
*/
@FullyTested
public static long checkPositive(long value, String argName) {
if (value <= 0) {
String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': Value is not positive: %d%s",
argName, value, w));
}
return value;
}
/**
* Tests if {@code value <= 0}
*
* @param value
* a value to test
* @param argName
* argument name for {@code value}, e.g., "strListSize" or "searchRegexLength"
*
* @return the validated value
*
* @throws IllegalArgumentException
* if {@code value > 0}
*
* @see #checkPositive(long, String)
* @see #checkNegative(long, String)
* @see #checkNotNegative(long, String)
*/
@FullyTested
public static long checkNotPositive(long value, String argName) {
if (value > 0) {
String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': Value is positive: %d%s",
argName, value, w));
}
return value;
}
/**
* Tests if {@code value < 0}
*
* @param value
* a value to test
* @param argName
* argument name for {@code value}, e.g., "strListSize" or "searchRegexLength"
*
* @return the validated value
*
* @throws IllegalArgumentException
* if {@code value => 0}
*
* @see #checkPositive(long, String)
* @see #checkNotPositive(long, String)
* @see #checkNotNegative(long, String)
*/
@FullyTested
public static long checkNegative(long value, String argName) {
if (value >= 0) {
String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': Value is not negative: %d%s",
argName, value, w));
}
return value;
}
/**
* Tests if {@code value >= 0}
*
* @param value
* a value to test
* @param argName
* argument name for {@code value}, e.g., "strListSize" or "searchRegexLength"
*
* @return the validated value
*
* @throws IllegalArgumentException
* if {@code value < 0}
*
* @see #checkPositive(long, String)
* @see #checkNotPositive(long, String)
* @see #checkNegative(long, String)
*/
@FullyTested
public static long checkNotNegative(long value, String argName) {
if (value < 0) {
String w = StringArgs._getArgNameWarning(argName, "argName");
throw new IllegalArgumentException(String.format(
"Argument '%s': Value is negative: %d%s",
argName, value, w));
}
return value;
}
/**
* Convenience method to call
* {@link ComparableArgs#checkValueRange(Comparable, Comparable, Comparable, String)}.
*
* @see #checkMinValue(long, long, String)
* @see #checkMaxValue(long, long, String)
* @see #checkExactValue(long, long, String)
* @see #checkNotExactValue(long, long, String)
*/
@FullyTested
public static long checkValueRange(
long value, long minValue, long maxValue, String argName) {
ComparableArgs.checkValueRange(value, minValue, maxValue, argName);
return value;
}
/**
* Convenience method to call
* {@link ComparableArgs#checkMinValue(Comparable, Comparable, String)}.
*
* @see #checkValueRange(long, long, long, String)
* @see #checkMaxValue(long, long, String)
* @see #checkExactValue(long, long, String)
* @see #checkNotExactValue(long, long, String)
*/
@FullyTested
public static long checkMinValue(long value, long minValue, String argName) {
ComparableArgs.checkMinValue(value, minValue, argName);
return value;
}
/**
* Convenience method to call
* {@link ComparableArgs#checkMaxValue(Comparable, Comparable, String)}.
*
* @see #checkValueRange(long, long, long, String)
* @see #checkMinValue(long, long, String)
* @see #checkExactValue(long, long, String)
* @see #checkNotExactValue(long, long, String)
*/
@FullyTested
public static long checkMaxValue(long value, long maxValue, String argName) {
ComparableArgs.checkMaxValue(value, maxValue, argName);
return value;
}
/**
* Convenience method to call
* {@link ComparableArgs#checkExactValue(Comparable, Comparable, String)}.
*
* @see #checkValueRange(long, long, long, String)
* @see #checkMinValue(long, long, String)
* @see #checkMaxValue(long, long, String)
* @see #checkNotExactValue(long, long, String)
*/
@FullyTested
public static long checkExactValue(long value, long exactValue, String argName) {
ComparableArgs.checkExactValue(value, exactValue, argName);
return value;
}
/**
* Convenience method to call
* {@link ComparableArgs#checkNotExactValue(Comparable, Comparable, String)}.
*
* @see #checkValueRange(long, long, long, String)
* @see #checkMinValue(long, long, String)
* @see #checkMaxValue(long, long, String)
* @see #checkExactValue(long, long, String)
*/
@FullyTested
public static long checkNotExactValue(long value, long exactValue, String argName) {
ComparableArgs.checkNotExactValue(value, exactValue, argName);
return value;
}
}