org.eclipse.webdav.dom.Assert Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.guvnor.eclipse.webdav

We build this plugin because eclipse no longer distributes it and Guvnor tools needs it.

There is a newer version: 7.48.0.Final

package org.eclipse.webdav.dom;

import org.eclipse.webdav.Policy;

/**
 * Assert is useful for for embedding runtime sanity checks
 * in code.
 * The predicate methods all test a condition and throw some
 * type of unchecked exception if the condition does not hold.
 * 
 * Assertion failure exceptions, like most runtime exceptions, are
 * thrown when something is misbehaving. Assertion failures are invariably
 * unspecified behavior; consequently, clients should never rely on
 * these being thrown (and certainly should not being catching them
 * specifically).
 * 
 * 
 * Note: This class/interface is part of an interim API that is still under 
 * development and expected to change significantly before reaching stability. 
 * It is being made available at this early stage to solicit feedback from pioneering 
 * adopters on the understanding that any code that uses this API will almost 
 * certainly be broken (repeatedly) as the API evolves.
 * 
 */
/* package */class Assert {
    /** Asserts that the given object is not null. If this
     * is not the case, some kind of unchecked exception is thrown.
     */
    public static void isNotNull(Object o) {
        isNotNull(o, ""); //$NON-NLS-1$
    }

    /** Asserts that the given object is not null. If this
     * is not the case, some kind of unchecked exception is thrown.
     * The given message is included in that exception, to aid debugging.
     */
    public static void isNotNull(Object o, String message) {
        if (o == null)
            throw new AssertionFailedException(Policy.bind("assert.nullArgument", message)); //$NON-NLS-1$
    }

    /** Asserts that the given boolean is true. If this
     * is not the case, some kind of unchecked exception is thrown.
     */
    public static boolean isTrue(boolean expression) {
        return isTrue(expression, ""); //$NON-NLS-1$
    }

    /** Asserts that the given boolean is true. If this
     * is not the case, some kind of unchecked exception is thrown.
     * The given message is included in that exception, to aid debugging.
     */
    public static boolean isTrue(boolean expression, String message) {
        if (!expression)
            throw new AssertionFailedException(Policy.bind("assert.failed", message)); //$NON-NLS-1$
        return expression;
    }
}