com.metamatrix.core.util
Class Assertion

java.lang.Object
  extended by com.metamatrix.core.util.Assertion

public final class Assertion
extends java.lang.Object

This class contains a set of static utility methods for assertion checking. Assertions are used to document the assumptions a programmer is making about the code they are writing. Assertions should not be used in cases where the user of a class can affect whether the assertion is true or false, such as argument checking. Rather, assertions should be considered a much stronger statement by the programmer that such a condition is NEVER true. In fact, this statement is so strong that assertions should be considered optional as they should never occur. However, these assertions may be violated during development and that is primarily where these assertions are useful.

In JDK 1.4, Sun introduces the "assert" keyword and builds assertion support directly into the language. When MetaMatrix begins using JDK 1.4 across the board, this class should no longer be needed and all usage of assertions should be replaced with use of the built-in JDK assertion facility.

See Also:
com.metamatrix.common.util.ArgCheck

Method Summary
static void assertTrue(boolean condition)
           
static void assertTrue(boolean condition, java.lang.String msgKey)
           
static void contains(java.util.Collection collection, java.lang.Object value)
           
static void contains(java.util.Collection collection, java.lang.Object value, java.lang.String message)
           
static void containsKey(java.util.Map map, java.lang.Object key)
           
static void containsKey(java.util.Map map, java.lang.Object key, java.lang.String message)
           
static void failed(java.lang.String msg)
           
static void isEqual(boolean value1, boolean value2)
           
static void isEqual(boolean value1, boolean value2, java.lang.String message)
           
static void isEqual(int value1, int value2)
           
static void isEqual(int value1, int value2, java.lang.String message)
           
static void isEqual(long value1, long value2)
           
static void isEqual(long value1, long value2, java.lang.String message)
           
static void isEqual(java.lang.Object object1, java.lang.Object object2)
          Compares with object1.equals(object2).
static void isEqual(java.lang.Object object1, java.lang.Object object2, java.lang.String message)
          Compares with object1.equals(object2).
static void isIdentical(java.lang.Object object1, java.lang.Object object2)
          Compares with object1 == object2.
static void isIdentical(java.lang.Object object1, java.lang.Object object2, java.lang.String message)
          Compares with object1 == object2.
static java.lang.Object isInstanceOf(java.lang.Object object, java.lang.Class expectedClass, java.lang.String name)
          Verifies that the specified value is an instance of the specified class.
static void isNegative(int value)
           
static void isNegative(int value, java.lang.String message)
           
static void isNegative(long value)
           
static void isNegative(long value, java.lang.String message)
           
static void isNonNegative(int value)
           
static void isNonNegative(int value, java.lang.String message)
           
static void isNonNegative(long value)
           
static void isNonNegative(long value, java.lang.String message)
           
static void isNonPositive(int value)
           
static void isNonPositive(int value, java.lang.String message)
           
static void isNonPositive(long value)
           
static void isNonPositive(long value, java.lang.String message)
           
static void isNotEmpty(java.util.Collection collection)
           
static void isNotEmpty(java.util.Collection collection, java.lang.String message)
           
static void isNotEmpty(java.util.Map map)
           
static void isNotEmpty(java.util.Map map, java.lang.String message)
           
static void isNotEqual(boolean value1, boolean value2)
           
static void isNotEqual(boolean value1, boolean value2, java.lang.String message)
           
static void isNotEqual(int value1, int value2)
           
static void isNotEqual(int value1, int value2, java.lang.String message)
           
static void isNotEqual(long value1, long value2)
           
static void isNotEqual(long value1, long value2, java.lang.String message)
           
static void isNotNull(java.lang.Object value)
           
static void isNotNull(java.lang.Object value, java.lang.String message)
           
static void isNotZeroLength(java.lang.String value)
           
static void isNotZeroLength(java.lang.String value, java.lang.String message)
           
static void isNull(java.lang.Object value)
           
static void isNull(java.lang.Object value, java.lang.String message)
           
static void isPositive(int value)
           
static void isPositive(int value, java.lang.String message)
           
static void isPositive(long value)
           
static void isPositive(long value, java.lang.String message)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

assertTrue

public static final void assertTrue(boolean condition)

assertTrue

public static final void assertTrue(boolean condition,
                                    java.lang.String msgKey)

failed

public static final void failed(java.lang.String msg)

isEqual

public static final void isEqual(boolean value1,
                                 boolean value2)

isEqual

public static final void isEqual(boolean value1,
                                 boolean value2,
                                 java.lang.String message)

isNotEqual

public static final void isNotEqual(boolean value1,
                                    boolean value2)

isNotEqual

public static final void isNotEqual(boolean value1,
                                    boolean value2,
                                    java.lang.String message)

isEqual

public static final void isEqual(int value1,
                                 int value2)

isEqual

public static final void isEqual(int value1,
                                 int value2,
                                 java.lang.String message)

isNotEqual

public static final void isNotEqual(int value1,
                                    int value2)

isNotEqual

public static final void isNotEqual(int value1,
                                    int value2,
                                    java.lang.String message)

isNonNegative

public static final void isNonNegative(int value)

isNonNegative

public static final void isNonNegative(int value,
                                       java.lang.String message)

isNonPositive

public static final void isNonPositive(int value)

isNonPositive

public static final void isNonPositive(int value,
                                       java.lang.String message)

isNegative

public static final void isNegative(int value)

isNegative

public static final void isNegative(int value,
                                    java.lang.String message)

isPositive

public static final void isPositive(int value)

isPositive

public static final void isPositive(int value,
                                    java.lang.String message)

isEqual

public static final void isEqual(long value1,
                                 long value2)

isEqual

public static final void isEqual(long value1,
                                 long value2,
                                 java.lang.String message)

isNotEqual

public static final void isNotEqual(long value1,
                                    long value2)

isNotEqual

public static final void isNotEqual(long value1,
                                    long value2,
                                    java.lang.String message)

isNonNegative

public static final void isNonNegative(long value)

isNonNegative

public static final void isNonNegative(long value,
                                       java.lang.String message)

isNonPositive

public static final void isNonPositive(long value)

isNonPositive

public static final void isNonPositive(long value,
                                       java.lang.String message)

isNegative

public static final void isNegative(long value)

isNegative

public static final void isNegative(long value,
                                    java.lang.String message)

isPositive

public static final void isPositive(long value)

isPositive

public static final void isPositive(long value,
                                    java.lang.String message)

isNotZeroLength

public static final void isNotZeroLength(java.lang.String value)

isNotZeroLength

public static final void isNotZeroLength(java.lang.String value,
                                         java.lang.String message)

isNull

public static final void isNull(java.lang.Object value)

isNull

public static final void isNull(java.lang.Object value,
                                java.lang.String message)

isNotNull

public static final void isNotNull(java.lang.Object value)

isNotNull

public static final void isNotNull(java.lang.Object value,
                                   java.lang.String message)

isIdentical

public static final void isIdentical(java.lang.Object object1,
                                     java.lang.Object object2)
Compares with object1 == object2.


isIdentical

public static final void isIdentical(java.lang.Object object1,
                                     java.lang.Object object2,
                                     java.lang.String message)
Compares with object1 == object2.


isEqual

public static final void isEqual(java.lang.Object object1,
                                 java.lang.Object object2)
Compares with object1.equals(object2).


isEqual

public static final void isEqual(java.lang.Object object1,
                                 java.lang.Object object2,
                                 java.lang.String message)
Compares with object1.equals(object2).


isInstanceOf

public static final java.lang.Object isInstanceOf(java.lang.Object object,
                                                  java.lang.Class expectedClass,
                                                  java.lang.String name)
Verifies that the specified value is an instance of the specified class.

Parameters:
value - The value to verify
exprectedClass - The class of which the value must be an instance
name - The text identifying the name or type of value
Throws:
java.lang.ClassCastException - If the value is not an instance of the specified class.
Since:
2.1

isNotEmpty

public static final void isNotEmpty(java.util.Collection collection)

isNotEmpty

public static final void isNotEmpty(java.util.Collection collection,
                                    java.lang.String message)

isNotEmpty

public static final void isNotEmpty(java.util.Map map)

isNotEmpty

public static final void isNotEmpty(java.util.Map map,
                                    java.lang.String message)

contains

public static final void contains(java.util.Collection collection,
                                  java.lang.Object value)

contains

public static final void contains(java.util.Collection collection,
                                  java.lang.Object value,
                                  java.lang.String message)

containsKey

public static final void containsKey(java.util.Map map,
                                     java.lang.Object key)

containsKey

public static final void containsKey(java.util.Map map,
                                     java.lang.Object key,
                                     java.lang.String message)


Copyright © 2009. All Rights Reserved.