com.redhat.rhn.common.util

Class Asserts

java.lang.Object

com.redhat.rhn.common.util.Asserts

public final class Asserts
extends java.lang.Object

Assertions that should be used to check parameters on public methods. Note that, as opposed to the assert keyword, these checks can not and should not be turned off.

See Sun's assert specification for recommended best practices.

Method Summary

Modifier and Type	Method and Description
static void	assertContains(java.util.Collection coll, java.lang.Object elem) Assert that coll contains elem
static void	assertEquals(int expected, int actual) Verify that two values are equal.
static void	assertEquals(int expected, int actual, java.lang.String expectedLabel, java.lang.String actualLabel) Verify that two values are equal.
static void	assertEquals(java.lang.Object expected, java.lang.Object actual) Verify that two values are equal (according to their equals method, unless expected is null, then according to ==).
static void	assertEquals(java.lang.Object expected, java.lang.Object actual, java.lang.String expectedLabel, java.lang.String actualLabel) Verify that two values are equal (according to their equals method, unless expected is null, then according to ==).
static void	assertNotEmpty(java.lang.String s) Verify that a string is not empty and throw a runtime exception if so.
static void	assertNotEmpty(java.lang.String s, java.lang.String label) Verify that a string is not empty and throw a runtime exception if so.
static void	assertNotNull(java.lang.Object o) Verify that a parameter is not null and throw a runtime exception if so.
static void	assertNotNull(java.lang.Object o, java.lang.String label) Verify that a parameter is not null and throw a runtime exception if so.
static void	assertTrue(boolean cond) Assert that an arbitrary condition is true and throw an exception if the condition is false.
static void	assertTrue(boolean cond, java.lang.String msg) Assert that an arbitrary condition is true throw an exception with message msg if the condition is false.
static void	fail(java.lang.String msg) This is the equivalent of assertTrue(false, msg).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

assertTrue

public static void assertTrue(boolean cond)
                       throws java.lang.IllegalStateException

Assert that an arbitrary condition is true and throw an exception if the condition is false.

Parameters:

cond - condition to assert

Throws:

java.lang.IllegalStateException - if condition is false

assertTrue

public static void assertTrue(boolean cond,
                              java.lang.String msg)
                       throws java.lang.IllegalStateException

Assert that an arbitrary condition is true throw an exception with message msg if the condition is false.

Parameters:

cond - condition to assert

msg - failure message

Throws:

java.lang.IllegalStateException - if condition is false

assertNotNull

public static void assertNotNull(java.lang.Object o)
                          throws java.lang.IllegalStateException

Verify that a parameter is not null and throw a runtime exception if so.

Parameters:

o - the object that should not be null

Throws:

java.lang.IllegalStateException - if o is null

assertNotNull

public static void assertNotNull(java.lang.Object o,
                                 java.lang.String label)
                          throws java.lang.IllegalStateException

Verify that a parameter is not null and throw a runtime exception if so.

Parameters:

o - the object that should not be null

label - the label for o to include in the error message

Throws:

java.lang.IllegalStateException - if o is null

assertNotEmpty

public static void assertNotEmpty(java.lang.String s)
                           throws java.lang.IllegalStateException

Verify that a string is not empty and throw a runtime exception if so. A parameter is considered empty if it is null, or if it does not contain any characters that are non-whitespace.

Parameters:

s - the string to check for emptiness

Throws:

java.lang.IllegalStateException - if s is an empty string

assertNotEmpty

public static void assertNotEmpty(java.lang.String s,
                                  java.lang.String label)
                           throws java.lang.IllegalStateException

Verify that a string is not empty and throw a runtime exception if so. A parameter is considered empty if it is null, or if it does not contain any characters that are non-whitespace.

Parameters:

s - the string to check for emptiness

label - the label for s to include in the error message

Throws:

java.lang.IllegalStateException - if s is an empty string

assertEquals

public static void assertEquals(java.lang.Object expected,
                                java.lang.Object actual)
                         throws java.lang.IllegalStateException

Verify that two values are equal (according to their equals method, unless expected is null, then according to ==).

Parameters:

expected - Expected value.

actual - Actual value.

Throws:

java.lang.IllegalStateException - if expected is not equal to actual

assertEquals

public static void assertEquals(java.lang.Object expected,
                                java.lang.Object actual,
                                java.lang.String expectedLabel,
                                java.lang.String actualLabel)
                         throws java.lang.IllegalStateException

Verify that two values are equal (according to their equals method, unless expected is null, then according to ==).

Parameters:

expected - Expected value.

actual - Actual value.

expectedLabel - Label for first (generally expected) value.

actualLabel - Label for second (generally actual) value.

Throws:

java.lang.IllegalStateException - condition was false

assertEquals

public static void assertEquals(int expected,
                                int actual)
                         throws java.lang.IllegalStateException

Verify that two values are equal.

Parameters:

expected - Expected value.

actual - Actual value.

Throws:

java.lang.IllegalStateException - if expected != actual

assertEquals

public static void assertEquals(int expected,
                                int actual,
                                java.lang.String expectedLabel,
                                java.lang.String actualLabel)
                         throws java.lang.IllegalStateException

Verify that two values are equal.

Parameters:

expected - Expected value.

actual - Actual value.

expectedLabel - Label for first (generally expected) value.

actualLabel - Label for second (generally actual) value.

Throws:

java.lang.IllegalStateException - if expected != actual

assertContains

public static void assertContains(java.util.Collection coll,
                                  java.lang.Object elem)

Assert that coll contains elem

Parameters:

coll - a collection

elem - the element that should be in the collection

fail

public static void fail(java.lang.String msg)
                 throws java.lang.IllegalStateException

This is the equivalent of assertTrue(false, msg).

Parameters:

msg - A string describing the condition of failure.

Throws:

java.lang.IllegalStateException - always