com.metsci.glimpse.jogamp.opengl.util.awt.text.Check Maven / Gradle / Ivy
/*
* Copyright 2012 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.metsci.glimpse.jogamp.opengl.util.awt.text;
/**
* Utility for checking arguments and preconditions.
*/
/*@ThreadSafe*/
public final class Check {
/**
* Prevents instantiation.
*/
private Check() {
// empty
}
/**
* Ensures an argument is valid.
*
* @param condition Condition involving argument that should be true
* @param message Message of exception thrown if condition is false
* @throws IllegalArgumentException if condition is false
*/
public static void argument(final boolean condition, /*@CheckForNull*/ final String message) {
if (!condition) {
throw new IllegalArgumentException(message);
}
}
/**
* Ensures an object is not null.
*
* @param obj Object to check
* @param message Message of exception thrown if object is null
* @return Reference to the given object, not null
* @throws NullPointerException if object is null
*/
/*@Nonnull*/
public static T notNull(/*@Nullable*/ final T obj,
/*@CheckForNull*/ final String message) {
if (obj == null) {
throw new NullPointerException(message);
}
return obj;
}
/**
* Ensures the state of an object is valid when a method's called.
*
* @param condition Condition involving state that should be true
* @param message Message of exception thrown if condition is false
* @throws IllegalStateException if condition is false
*/
public static void state(final boolean condition, /*@CheckForNull*/ final String message) {
if (!condition) {
throw new IllegalStateException(message);
}
}
}