Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* JBoss, Home of Professional Open Source.
* Copyright 2015 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wildfly.common;
import java.util.Collection;
import java.util.Map;
import org.wildfly.common._private.CommonMessages;
import org.wildfly.common.annotation.NotNull;
/**
* A set of assertions and checks.
*
* @author David M. Lloyd
*/
public final class Assert {
private Assert() {
}
/**
* Check that the named parameter is not {@code null}. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @param the value type
* @return the value that was passed in
* @throws IllegalArgumentException if the value is {@code null}
*/
@NotNull
public static T checkNotNullParam(String name, T value) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked(name, value);
return value;
}
/**
* Check that the named parameter is not {@code null}, using a {@code NullPointerException} as some specifications
* require. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @param the value type
* @return the value that was passed in
* @throws NullPointerException if the value is {@code null}
*/
@NotNull
public static T checkNotNullParamWithNullPointerException(String name, T value) throws NullPointerException {
checkNotNullParamChecked("name", name);
if (value == null) throw CommonMessages.msg.nullParamNPE(name);
return value;
}
private static void checkNotNullParamChecked(final String name, final T value) {
if (value == null) throw CommonMessages.msg.nullParam(name);
}
/**
* Check that a value within the named array parameter is not {@code null}. Use a standard exception message if it
* is.
*
* @param name the parameter name
* @param index the array index
* @param value the array element value
* @param the element value type
* @return the array element value that was passed in
* @throws IllegalArgumentException if the value is {@code null}
*/
@NotNull
public static T checkNotNullArrayParam(String name, int index, T value) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
if (value == null) throw CommonMessages.msg.nullArrayParam(index, name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static String checkNotEmptyParam(String name, String value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.isEmpty()) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static > T checkNotEmptyParam(String name, T value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.isEmpty()) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static > T checkNotEmptyParam(String name, T value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.isEmpty()) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static T[] checkNotEmptyParam(String name, T[] value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.length == 0) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static boolean[] checkNotEmptyParam(String name, boolean[] value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.length == 0) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static byte[] checkNotEmptyParam(String name, byte[] value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.length == 0) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static short[] checkNotEmptyParam(String name, short[] value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.length == 0) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static int[] checkNotEmptyParam(String name, int[] value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.length == 0) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static long[] checkNotEmptyParam(String name, long[] value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.length == 0) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static float[] checkNotEmptyParam(String name, float[] value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.length == 0) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is not empty. Use a standard exception message if it is.
*
* @param name the parameter name
* @param value the parameter value
* @return the value that was passed in
* @throws IllegalArgumentException if the value is empty
*/
@NotNull
public static double[] checkNotEmptyParam(String name, double[] value) {
checkNotNullParamChecked("name", name);
checkNotNullParamChecked("value", value);
if (value.length == 0) throw CommonMessages.msg.emptyParam(name);
return value;
}
/**
* Check that the named parameter is greater than or equal to {@code min}.
*
* @param name the parameter name
* @param min the minimum value
* @param actual the actual parameter value
* @throws IllegalArgumentException if the actual value is less than the minimum value
*/
public static void checkMinimumParameter(String name, int min, int actual) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
if (actual < min) throw CommonMessages.msg.paramLessThan(name, min);
}
/**
* Check that the named parameter is greater than or equal to {@code min}.
*
* @param name the parameter name
* @param min the minimum value
* @param actual the actual parameter value
* @throws IllegalArgumentException if the actual value is less than the minimum value
*/
public static void checkMinimumParameter(String name, long min, long actual) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
if (actual < min) throw CommonMessages.msg.paramLessThan(name, min);
}
/**
* Check that the named parameter is greater than or equal to {@code min}.
*
* @param name the parameter name
* @param min the minimum value
* @param actual the actual parameter value
* @throws IllegalArgumentException if the actual value is less than the minimum value
*/
public static void checkMinimumParameter(String name, float min, float actual) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
if (actual < min) throw CommonMessages.msg.paramLessThan(name, min);
}
/**
* Check that the named parameter is greater than or equal to {@code min}.
*
* @param name the parameter name
* @param min the minimum value
* @param actual the actual parameter value
* @throws IllegalArgumentException if the actual value is less than the minimum value
*/
public static void checkMinimumParameter(String name, double min, double actual) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
if (actual < min) throw CommonMessages.msg.paramLessThan(name, min);
}
/**
* Check that the named parameter is less than or equal to {@code max}.
*
* @param name the parameter name
* @param max the maximum value
* @param actual the actual parameter value
* @throws IllegalArgumentException if the actual value is greater than the minimum value
*/
public static void checkMaximumParameter(String name, int max, int actual) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
if (actual > max) throw CommonMessages.msg.paramGreaterThan(name, max);
}
/**
* Check that the named parameter is less than or equal to {@code max}.
*
* @param name the parameter name
* @param max the maximum value
* @param actual the actual parameter value
* @throws IllegalArgumentException if the actual value is greater than the minimum value
*/
public static void checkMaximumParameter(String name, long max, long actual) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
if (actual > max) throw CommonMessages.msg.paramGreaterThan(name, max);
}
/**
* Check that the named parameter is less than or equal to {@code max}.
*
* @param name the parameter name
* @param max the maximum value
* @param actual the actual parameter value
* @throws IllegalArgumentException if the actual value is greater than the minimum value
*/
public static void checkMaximumParameter(String name, float max, float actual) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
if (actual > max) throw CommonMessages.msg.paramGreaterThan(name, max);
}
/**
* Check that the named parameter is less than or equal to {@code max}.
*
* @param name the parameter name
* @param max the maximum value
* @param actual the actual parameter value
* @throws IllegalArgumentException if the actual value is greater than the minimum value
*/
public static void checkMaximumParameter(String name, double max, double actual) throws IllegalArgumentException {
checkNotNullParamChecked("name", name);
if (actual > max) throw CommonMessages.msg.paramGreaterThan(name, max);
}
/**
* Check that the given offset and length fall completely within the bounds of the given array.
*
* @param array the array to check
* @param offs the array offset
* @param len the array length
* @throws ArrayIndexOutOfBoundsException if the range of the offset and length do not fall within the array bounds
*/
public static void checkArrayBounds(final Object[] array, final int offs, final int len) throws ArrayIndexOutOfBoundsException {
checkNotNullParamChecked("array", array);
checkArrayBounds(array.length, offs, len);
}
/**
* Check that the given offset and length fall completely within the bounds of the given array.
*
* @param array the array to check
* @param offs the array offset
* @param len the array length
* @throws ArrayIndexOutOfBoundsException if the range of the offset and length do not fall within the array bounds
*/
public static void checkArrayBounds(final byte[] array, final int offs, final int len) throws ArrayIndexOutOfBoundsException {
checkNotNullParamChecked("array", array);
checkArrayBounds(array.length, offs, len);
}
/**
* Check that the given offset and length fall completely within the bounds of the given array.
*
* @param array the array to check
* @param offs the array offset
* @param len the array length
* @throws ArrayIndexOutOfBoundsException if the range of the offset and length do not fall within the array bounds
*/
public static void checkArrayBounds(final char[] array, final int offs, final int len) throws ArrayIndexOutOfBoundsException {
checkNotNullParamChecked("array", array);
checkArrayBounds(array.length, offs, len);
}
/**
* Check that the given offset and length fall completely within the bounds of the given array.
*
* @param array the array to check
* @param offs the array offset
* @param len the array length
* @throws ArrayIndexOutOfBoundsException if the range of the offset and length do not fall within the array bounds
*/
public static void checkArrayBounds(final int[] array, final int offs, final int len) throws ArrayIndexOutOfBoundsException {
checkNotNullParamChecked("array", array);
checkArrayBounds(array.length, offs, len);
}
/**
* Check that the given offset and length fall completely within the bounds of the given array.
*
* @param array the array to check
* @param offs the array offset
* @param len the array length
* @throws ArrayIndexOutOfBoundsException if the range of the offset and length do not fall within the array bounds
*/
public static void checkArrayBounds(final long[] array, final int offs, final int len) throws ArrayIndexOutOfBoundsException {
checkNotNullParamChecked("array", array);
checkArrayBounds(array.length, offs, len);
}
/**
* Check that the given offset and length fall completely within the bounds of the given array length.
*
* @param arrayLength the array length to check against
* @param offs the array offset
* @param len the array length
* @throws ArrayIndexOutOfBoundsException if the range of the offset and length do not fall within the array bounds
*/
public static void checkArrayBounds(final int arrayLength, final int offs, final int len) throws ArrayIndexOutOfBoundsException {
checkMinimumParameter("offs", 0, offs);
checkMinimumParameter("len", 0, len);
if (offs > arrayLength) throw CommonMessages.msg.arrayOffsetGreaterThanLength(offs, arrayLength);
if (offs + len > arrayLength) throw CommonMessages.msg.arrayOffsetLengthGreaterThanLength(offs, len, arrayLength);
}
/**
* Assert that the value is not {@code null}. Use a standard assertion failure message if it is. Only
* runs if {@code assert} is enabled.
*
* @param value the not-{@code null} value
* @param the value type
* @return the value that was passed in
*/
@NotNull
public static T assertNotNull(T value) {
assert value != null : CommonMessages.msg.unexpectedNullValue();
return value;
}
/**
* Assert that the given monitor is held by the current thread. Use a standard assertion failure message if it is not.
* Only runs if {@code assert} is enabled.
*
* @param monitor the monitor object
* @param the monitor's type
* @return the value that was passed in
* @throws IllegalArgumentException if the monitor is {@code null}
*/
@NotNull
public static T assertHoldsLock(@NotNull T monitor) {
assert Thread.holdsLock(checkNotNullParam("monitor", monitor)) : CommonMessages.msg.expectedLockHold(monitor);
return monitor;
}
/**
* Assert that the given monitor is not held by the current thread. Use a standard assertion failure message if it is.
* Only runs if {@code assert} is enabled.
*
* @param monitor the monitor object
* @param the monitor's type
* @return the value that was passed in
* @throws IllegalArgumentException if the monitor is {@code null}
*/
@NotNull
public static T assertNotHoldsLock(@NotNull T monitor) {
assert ! Thread.holdsLock(checkNotNullParam("monitor", monitor)) : CommonMessages.msg.expectedLockNotHold(monitor);
return monitor;
}
/**
* Assert that the given expression is always {@code true}.
*
* @param expr the boolean expression
* @return the boolean expression
*/
@SuppressWarnings("ConstantConditions")
public static boolean assertTrue(boolean expr) {
assert expr : CommonMessages.msg.expectedBoolean(expr);
return expr;
}
/**
* Assert that the given expression is always {@code false}.
*
* @param expr the boolean expression
* @return the boolean expression
*/
@SuppressWarnings("ConstantConditions")
public static boolean assertFalse(boolean expr) {
assert ! expr : CommonMessages.msg.expectedBoolean(expr);
return expr;
}
/**
* Return an exception indicating that the current code was intended to be unreachable.
*
* @return the exception which may be immediately thrown
*/
public static IllegalStateException unreachableCode() {
return CommonMessages.msg.unreachableCode();
}
/**
* Return an exception indicating that the current switch case was intended to be unreachable.
*
* @param obj the switch case value
* @return the exception which may be immediately thrown
*/
@NotNull
public static IllegalStateException impossibleSwitchCase(@NotNull Object obj) {
Assert.checkNotNullParamChecked("obj", obj);
return CommonMessages.msg.impossibleSwitchCase(obj);
}
/**
* Return an exception indicating that the current switch case was intended to be unreachable.
*
* @param val the switch case value
* @return the exception which may be immediately thrown
*/
@NotNull
public static IllegalStateException impossibleSwitchCase(int val) {
return CommonMessages.msg.impossibleSwitchCase(Integer.valueOf(val));
}
/**
* Return an exception indicating that the current switch case was intended to be unreachable.
*
* @param val the switch case value
* @return the exception which may be immediately thrown
*/
@NotNull
public static IllegalStateException impossibleSwitchCase(long val) {
return CommonMessages.msg.impossibleSwitchCase(Long.valueOf(val));
}
/**
* Return an exception explaining that the caller's method is not supported.
*
* @return the exception
*/
@NotNull
public static UnsupportedOperationException unsupported() {
final StackTraceElement element = new Throwable().getStackTrace()[1];
return CommonMessages.msg.unsupported(element.getMethodName(), element.getClassName());
}
}
