Please wait. This can take some minutes ...
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.
org.nd4j.common.base.Preconditions Maven / Gradle / Ivy
/*
* ******************************************************************************
* *
* *
* * This program and the accompanying materials are made available under the
* * terms of the Apache License, Version 2.0 which is available at
* * https://www.apache.org/licenses/LICENSE-2.0.
* *
* * See the NOTICE file distributed with this work for additional
* * information regarding copyright ownership.
* * 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.
* *
* * SPDX-License-Identifier: Apache-2.0
* *****************************************************************************
*/
package org.nd4j.common.base;
import org.nd4j.common.config.ND4JClassLoading;
import java.util.*;
public final class Preconditions {
private static final Map FORMATTERS = new HashMap<>();
static {
ServiceLoader sl = ND4JClassLoading.loadService(PreconditionsFormat.class);
for (PreconditionsFormat pf : sl) {
List formatTags = pf.formatTags();
for(String s : formatTags){
FORMATTERS.put(s, pf);
}
}
}
private Preconditions() {
}
/**
* Check the specified boolean argument. Throws an IllegalArgumentException if {@code b} is false
*
* @param b Argument to check
*/
public static void checkArgument(boolean b) {
if (!b) {
throw new IllegalArgumentException();
}
}
/**
* Check the specified boolean argument. Throws an IllegalArgumentException with the specified message if {@code b} is false
*
* @param b Argument to check
* @param message Message for exception. May be null
*/
public static void checkArgument(boolean b, String message) {
if (!b) {
throwEx(message);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, int arg1) {
if (!b) {
throwEx(msg, arg1);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, long arg1) {
if (!b) {
throwEx(msg, arg1);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, double arg1) {
if (!b) {
throwEx(msg, arg1);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, Object arg1) {
if (!b) {
throwEx(msg, arg1);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, int arg1, int arg2) {
if (!b) {
throwEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, long arg1, long arg2) {
if (!b) {
throwEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, double arg1, double arg2) {
if (!b) {
throwEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, Object arg1, Object arg2) {
if (!b) {
throwEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, int arg1, int arg2, int arg3) {
if (!b) {
throwEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, long arg1, long arg2, long arg3) {
if (!b) {
throwEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, double arg1, double arg2, double arg3) {
if (!b) {
throwEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, Object arg1, Object arg2, Object arg3) {
if (!b) {
throwEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, int arg1, int arg2, int arg3, int arg4) {
if (!b) {
throwEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, long arg1, long arg2, long arg3, long arg4) {
if (!b) {
throwEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, double arg1, double arg2, double arg3, double arg4) {
if (!b) {
throwEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4) {
if (!b) {
throwEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5) {
if (!b) {
throwEx(msg, arg1, arg2, arg3, arg4, arg5);
}
}
/**
* See {@link #checkArgument(boolean, String, Object...)}
*/
public static void checkArgument(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6) {
if (!b) {
throwEx(msg, arg1, arg2, arg3, arg4, arg5, arg6);
}
}
/**
* Check the specified boolean argument. Throws an IllegalArgumentException with the specified message if {@code b} is false.
* Note that the message may specify argument locations using "%s" - for example,
* {@code checkArgument(false, "Got %s values, expected %s", 3, "more"} would throw an IllegalArgumentException
* with the message "Got 3 values, expected more"
*
* @param b Argument to check
* @param message Message for exception. May be null.
* @param args Arguments to place in message
*/
public static void checkArgument(boolean b, String message, Object... args) {
if (!b) {
throwEx(message, args);
}
}
/**
* Check the specified boolean argument. Throws an IllegalStateException if {@code b} is false
*
* @param b State to check
*/
public static void checkState(boolean b) {
if (!b) {
throw new IllegalStateException();
}
}
/**
* Check the specified boolean argument. Throws an IllegalStateException with the specified message if {@code b} is false
*
* @param b State to check
* @param message Message for exception. May be null
*/
public static void checkState(boolean b, String message) {
if (!b) {
throwStateEx(message);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, int arg1) {
if (!b) {
throwStateEx(msg, arg1);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, long arg1) {
if (!b) {
throwStateEx(msg, arg1);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, double arg1) {
if (!b) {
throwStateEx(msg, arg1);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, Object arg1) {
if (!b) {
throwStateEx(msg, arg1);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, int arg1, int arg2) {
if (!b) {
throwStateEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, long arg1, long arg2) {
if (!b) {
throwStateEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, double arg1, double arg2) {
if (!b) {
throwStateEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, Object arg1, Object arg2) {
if (!b) {
throwStateEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, int arg1, int arg2, int arg3) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, long arg1, long arg2, long arg3) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, double arg1, double arg2, double arg3) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, Object arg1, Object arg2, Object arg3) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, int arg1, int arg2, int arg3, int arg4) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, long arg1, long arg2, long arg3, long arg4) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, double arg1, double arg2, double arg3, double arg4) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3, arg4, arg5);
}
}
/**
* See {@link #checkState(boolean, String, Object...)}
*/
public static void checkState(boolean b, String msg, Object arg1, Object arg2, Object arg3, Object arg4, Object arg5, Object arg6) {
if (!b) {
throwStateEx(msg, arg1, arg2, arg3, arg4, arg5, arg6);
}
}
/**
* Check the specified boolean argument. Throws an IllegalStateException with the specified message if {@code b} is false.
* Note that the message may specify argument locations using "%s" - for example,
* {@code checkArgument(false, "Got %s values, expected %s", 3, "more"} would throw an IllegalStateException
* with the message "Got 3 values, expected more"
*
* @param b Argument to check
* @param message Message for exception. May be null.
* @param args Arguments to place in message
*/
public static void checkState(boolean b, String message, Object... args) {
if (!b) {
throwStateEx(message, args);
}
}
/**
* Check the specified boolean argument. Throws an NullPointerException if {@code o} is false
*
* @param o Object to check
*/
public static void checkNotNull(Object o) {
if (o == null) {
throw new NullPointerException();
}
}
/**
* Check the specified boolean argument. Throws an NullPointerException with the specified message if {@code o} is false
*
* @param o Object to check
* @param message Message for exception. May be null
*/
public static void checkNotNull(Object o, String message) {
if (o == null) {
throwNullPointerEx(message);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, int arg1) {
if (o == null) {
throwNullPointerEx(msg, arg1);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, long arg1) {
if (o == null) {
throwNullPointerEx(msg, arg1);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, double arg1) {
if (o == null) {
throwNullPointerEx(msg, arg1);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, Object arg1) {
if (o == null) {
throwNullPointerEx(msg, arg1);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, int arg1, int arg2) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, long arg1, long arg2) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, double arg1, double arg2) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, Object arg1, Object arg2) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, int arg1, int arg2, int arg3) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, long arg1, long arg2, long arg3) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, double arg1, double arg2, double arg3) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, Object arg1, Object arg2, Object arg3) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2, arg3);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, int arg1, int arg2, int arg3, int arg4) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, long arg1, long arg2, long arg3, long arg4) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, double arg1, double arg2, double arg3, double arg4) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* See {@link #checkNotNull(Object, String, Object...)}
*/
public static void checkNotNull(Object o, String msg, Object arg1, Object arg2, Object arg3, Object arg4) {
if (o == null) {
throwNullPointerEx(msg, arg1, arg2, arg3, arg4);
}
}
/**
* Check the specified boolean argument. Throws an IllegalStateException with the specified message if {@code o} is false.
* Note that the message may specify argument locations using "%s" - for example,
* {@code checkArgument(false, "Got %s values, expected %s", 3, "more"} would throw an IllegalStateException
* with the message "Got 3 values, expected more"
*
* @param o Object to check
* @param message Message for exception. May be null.
* @param args Arguments to place in message
*/
public static void checkNotNull(Object o, String message, Object... args) {
if (o == null) {
throwStateEx(message, args);
}
}
public static void throwEx(String message, Object... args) {
String f = format(message, args);
throw new IllegalArgumentException(f);
}
public static void throwStateEx(String message, Object... args) {
String f = format(message, args);
throw new IllegalStateException(f);
}
public static void throwNullPointerEx(String message, Object... args) {
String f = format(message, args);
throw new NullPointerException(f);
}
private static String format(String message, Object... args) {
if (message == null) {
message = "";
}
if (args == null) {
args = new Object[]{"null"};
}
StringBuilder sb = new StringBuilder();
int indexOfStart = 0;
boolean consumedMessageFully = false;
for (int i = 0; i < args.length; i++) {
//First: scan for next tag. This could be a %s, or it could be a custom loader for Preconditions class (PreconditionsFormat)
int nextIdx = message.indexOf("%s", indexOfStart);
int nextCustom = -1;
String nextCustomTag = null;
for(String s : FORMATTERS.keySet()){
int idxThis = message.indexOf(s, indexOfStart);
if(idxThis > 0 && (nextCustom < 0 || idxThis < nextCustom)){
nextCustom = idxThis;
nextCustomTag = s;
}
}
if (nextIdx < 0 && nextCustom < 0) {
//Malformed message: No more "%s" (or custom tags) to replace, but more message args
if (!consumedMessageFully) {
sb.append(message.substring(indexOfStart));
consumedMessageFully = true;
sb.append(" [");
while (i < args.length) {
sb.append(formatArg(args[i]));
if (i < args.length - 1) {
sb.append(",");
}
i++;
}
sb.append("]");
}
} else {
if(nextCustom < 0 || (nextIdx > 0 && nextIdx < nextCustom)){
//%s tag
sb.append(message.substring(indexOfStart, nextIdx))
.append(formatArg(args[i]));
indexOfStart = nextIdx + 2;
} else {
//Custom tag
sb.append(message.substring(indexOfStart, nextCustom));
String s = FORMATTERS.get(nextCustomTag).format(nextCustomTag, args[i]);
sb.append(s);
indexOfStart = nextCustom + nextCustomTag.length();
}
}
}
if (!consumedMessageFully) {
sb.append(message.substring(indexOfStart));
}
return sb.toString();
}
private static String formatArg(Object o){
if(o == null){
return "null";
}
if(o.getClass().isArray()){
return formatArray(o);
}
return o.toString();
}
public static String formatArray(Object o){
if(o == null)
return "null";
if(o.getClass().getComponentType().isPrimitive()){
if(o instanceof byte[]) {
return Arrays.toString((byte[])o);
} else if(o instanceof int[]){
return Arrays.toString((int[])o);
} else if(o instanceof long[]){
return Arrays.toString((long[])o);
} else if(o instanceof float[]){
return Arrays.toString((float[])o);
} else if(o instanceof double[]){
return Arrays.toString((double[])o);
} else if(o instanceof char[]){
return Arrays.toString((char[])o);
} else if(o instanceof boolean[]) {
return Arrays.toString((boolean[])o);
} else if(o instanceof short[]){
return Arrays.toString((short[])o);
} else {
//Should never happen
return o.toString();
}
} else {
Object[] arr = (Object[])o;
return Arrays.toString(arr);
}
}
}