com.cinchapi.common.base.Verify Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2015 Cinchapi Inc.
 * 
 * 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 com.cinchapi.common.base;

/**
 * A collection of functions to either successfully verify a condition or throw
 * an exception.
 * 
 * @author Jeff Nelson
 */
public final class Verify {

    /**
     * Verify that {@code object} is {@link Class#isAssignableFrom(Class) an
     * instance of} {@code type} or throw a {@link ClassCastException}.
     * 
     * 
Example
     * 
     *      * Verify.isType(new ArrayList<Object>(), List.class); // does nothing
     * Verify.isType(new ArrayList<Object>(), Set.class); // throws ClassCastException
     * 
     * 
     * 
     * 
     * @param object the object to check
     * @param type the expected {@link Class type} or super type for
     *            {@code object}
     */
    public static void isType(Object object, Class type) {
        isType(object, type, null);
    }

    /**
     * Verify that {@code object} is {@link Class#isAssignableFrom(Class) an
     * instance of} {@code type} or throw a {@link ClassCastException}.
     * 
     * 
Example
     * 
     *      * Verify.isType(new ArrayList<Object>(), List.class); // does nothing
     * Verify.isType(new ArrayList<Object>(), Set.class); // throws ClassCastException
     * 
     * 
     * 
     * 
     * @param object the object to check
     * @param type the expected {@link Class type} or super type for
     *            {@code object}
     * @param errorMsgTemplate the template for the error message; see
     *            {@link AnyStrings#format(String, Object...)} for more
     *            information
     * @param errorMsgArgs the values to inject in the {@code errorMsgTemplate}
     *            placeholders; see {@link AnyStrings#format(String, Object...)}
     *            for more information
     */
    public static void isType(Object object, Class type,
            String errorMsgTemplate, Object... errorMsgArgs) {
        if(!type.isAssignableFrom(object.getClass())) {
            throw new ClassCastException(AnyStrings.format(errorMsgTemplate,
                    errorMsgArgs));
        }
    }

    /**
     * Verify the truth of {@code condition} or throw an
     * {@link IllegalStateException}.
     * 
     * 
Example
     * 
     *      * Verify.that(1 < 2); //does nothing
     * Verify.that(1 > 2); throws IllegalStateException
     * 
     * 
     * 
     * 
     * @param condition the condition that should be {@code true}
     * @throws IllegalStateException if {@code condition} is false
     */
    public static void that(boolean condition) {
        that(condition, null);
    }

    /**
     * Verify the truth of the {@code condition} or throw an
     * {@link IllegalStateException}.
     * 
     * 
Example
     * 
     *      * Verify.that(1 < 2); //does nothing
     * Verify.that(1 > 2); throws IllegalStateException
     * Verify.that(1 > 2, "{} is not greater than {}", 1, 2); //throws IllegalStateException
     * 
     * 
     * 
     * 
     * @param condition the condition that should be {@code true}
     * @param errorMsgTemplate the template for the error message; see
     *            {@link AnyStrings#format(String, Object...)} for more
     *            information
     * @param errorMsgArgs the values to inject in the {@code errorMsgTemplate}
     *            placeholders; see {@link AnyStrings#format(String, Object...)}
     *            for more information
     * @throws IllegalStateException if {@code condition} is false
     */
    public static void that(boolean condition, String errorMsgTemplate,
            Object... errorMsgArgs) {
        if(!condition) {
            throw new IllegalStateException(AnyStrings.format(errorMsgTemplate,
                    errorMsgArgs));
        }
    }

    /**
     * Verify the truth of the {@code condition} about a method argument or
     * throw an {@link IllegalArgumentException}.
     * 
     * @param condition the condition that should be {@code true}
     * @throws IllegalArgumentException if {@code condition} is false
     */
    public static void thatArgument(boolean condition) {
        thatArgument(condition, null);
    }

    /**
     * Verify the truth of the {@code condition} about a method argument or
     * throw an {@link IllegalArgumentException}.
     * 
     * @param condition the condition that should be {@code true}
     * @param errorMsgTemplate the template for the error message; see
     *            {@link AnyStrings#format(String, Object...)} for more
     *            information
     * @param errorMsgArgs the values to inject in the {@code errorMsgTemplate}
     *            placeholders; see {@link AnyStrings#format(String, Object...)}
     *            for more information
     * @throws IllegalArgumentException if {@code condition} is false
     */
    public static void thatArgument(boolean condition, String errorMsgTemplate,
            Object... errorMsgArgs) {
        if(!condition) {
            throw new IllegalArgumentException(AnyStrings.format(
                    errorMsgTemplate, errorMsgArgs));
        }
    }

    private Verify() {/* noinit */}

}