com.jirvan.util.AssertionMethods Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ji-utils Show documentation
A general java utilities library
The newest version!
/*

Copyright (c) 2013, Jirvan Pty Ltd
All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

    * Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
    * 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.
    * Neither the name of Jirvan Pty Ltd nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER 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.

*/

package com.jirvan.util;

@Deprecated
public class AssertionMethods {

    /**
     * Asserts that a condition is true.  If the assertion
     * fails, then an {@link AssertionError} with the provided
     * message is thrown.
     *
     * @param message   the message associated with failure
     * @param condition the condition to be checked
     * @throws AssertionError with the provided message if the assertion fails
     */
    public static void assertTrue(String message, boolean condition) {
        if (!condition) throw message == null ? new AssertionError() : new AssertionError(message);
    }

    /**
     * Asserts that a condition is true.  If the assertion
     * fails, then an {@link AssertionError} is thrown.
     *
     * @param condition the condition to be checked
     * @throws AssertionError if the assertion fails
     */
    public static void assertTrue(boolean condition) {
        assertTrue(null, condition);
    }

    /**
     * Asserts that an object is an instance of the given class.  If the
     * assertion fails, then an {@link AssertionError} with the provided
     * message is thrown.
     *
     * @param message the message associated with failure
     * @param object  the object to be checked
     * @param aClass  the class the object needs to be checked against
     * @throws AssertionError with the provided message if the assertion fails
     */
    public static void assertObjectIsInstanceof(String message, Object object, Class aClass) {
        if (!aClass.isInstance(object)) {
            throw message != null
                  ? new AssertionError(message)
                  : new AssertionError(String.format("Object was expected to be a %s (it was a %s)",
                                                     aClass.getName(),
                                                     object.getClass().getName()));
        }
    }

    /**
     * Asserts that an object is an instance of the given class.  If the
     * assertion fails, then an {@link AssertionError}  is thrown.
     *
     * @param object the object to be checked
     * @param aClass the class the object needs to be checked against
     * @throws AssertionError if the assertion fails
     */
    public static void assertObjectIsInstanceof(Object object, Class aClass) {
        assertObjectIsInstanceof(null, object, aClass);
    }

    /**
     * Asserts that an object is not null.  If the assertion fails, then
     * an {@link AssertionError} with the provided message is thrown.
     *
     * @param message the message associated with failure
     * @param object  the object to be checked
     * @throws AssertionError with the provided message if the assertion fails
     */
    public static void assertNotNull(String message, Object object) {
        if (object == null) {
            throw message != null
                  ? new AssertionError(message)
                  : new AssertionError("Object was not expected to be null");
        }
    }

    /**
     * Asserts that an object is not null.  If the assertion fails, then
     * an {@link AssertionError} is thrown.
     *
     * @param object the object to be checked
     * @throws AssertionError with the provided message if the assertion fails
     */
    public static void assertNotNull(Object object) {
        assertNotNull(null, object);
    }

    /**
     * Asserts that an object is null.  If the assertion fails, then
     * an {@link AssertionError} with the provided message is thrown.
     *
     * @param message the message associated with failure
     * @param object  the object to be checked
     * @throws AssertionError with the provided message if the assertion fails
     */
    public static void assertNull(String message, Object object) {
        if (object != null) {
            throw message != null
                  ? new AssertionError(message)
                  : new AssertionError("Object was expected to be null");
        }
    }

    /**
     * Asserts that an object is null.  If the assertion fails, then
     * an {@link AssertionError} is thrown.
     *
     * @param object the object to be checked
     * @throws AssertionError with the provided message if the assertion fails
     */
    public static void assertNull(Object object) {
        assertNull(null, object);
    }

}