org.safs

Class SAFSPlus.Assert

java.lang.Object

org.safs.SAFSPlus.Assert

Direct Known Subclasses:

SeleniumPlus.Assert

Enclosing class:

SAFSPlus

public static class SAFSPlus.Assert
extends java.lang.Object

A set of assertions methods for tests. Only failed assertions are recorded.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Assert() Protected Constructor for static class.

Method Summary

Modifier and Type	Method and Description
static boolean	Equals(double actual, double expected) Assert two doubles or floats are equal using an absolute positive delta of 0.
static boolean	Equals(double actual, double expected, double delta) Assert two doubles or floats are equal within an absolute positive delta.
static boolean	Equals(double actual, double expected, double delta, java.lang.String customMessage) Assert two doubles or floats are equal within an absolute positive delta.
static boolean	Equals(long actual, long expected) Assert two longs or ints are equal.
static boolean	Equals(long actual, long expected, java.lang.String customMessage) Assert two longs or ints are equal.
static boolean	Equals(java.lang.Object actual, java.lang.Object expected) Assert two Objects are equal.
static boolean	Equals(java.lang.Object actual, java.lang.Object expected, java.lang.String customMessage) Assert two Objects are equal.
static void	fail() Issue a generic test failure.
static void	fail(java.lang.String customMessage) Issue a failure.
static boolean	False(boolean actual) Assert a boolean is false.
static boolean	False(boolean actual, java.lang.String customMessage) Assert a boolean is false.
static boolean	getAbortOnFailure()
(package private) static void	incrementCounters(boolean wasSuccessful)
static boolean	NotEqual(double actual, double expected) Assert two doubles or floats are NOT equal by an absolute positive delta of 0.
static boolean	NotEqual(double actual, double expected, double delta) Assert two doubles or floats are NOT equal by an absolute positive delta.
static boolean	NotEqual(double actual, double expected, double delta, java.lang.String customMessage) Assert two doubles or floats are NOT equal by an absolute positive delta.
static boolean	NotEqual(long actual, long expected) Assert two longs or ints are NOT equal.
static boolean	NotEqual(long actual, long expected, java.lang.String customMessage) Assert two longs or ints are NOT equal.
static boolean	NotEqual(java.lang.Object actual, java.lang.Object expected) Assert two Objects are NOT equal.
static boolean	NotEqual(java.lang.Object actual, java.lang.Object expected, java.lang.String customMessage) Assert two Objects are NOT equal.
static boolean	NotNull(java.lang.Object actual) Assert an Objects is NOT null.
static boolean	NotNull(java.lang.Object actual, java.lang.String customMessage) Assert an Object is NOT null.
static boolean	NotSame(java.lang.Object actual, java.lang.Object expected) Assert an Object is NOT the same object as the expected Object.
static boolean	NotSame(java.lang.Object actual, java.lang.Object expected, java.lang.String customMessage) Assert an Object is NOT the same object as the expected Object.
static boolean	Null(java.lang.Object actual) Assert an Objects IS null.
static boolean	Null(java.lang.Object actual, java.lang.String customMessage) Assert an Object IS null.
static boolean	Same(java.lang.Object actual, java.lang.Object expected) Assert an Object is the same object as the expected Object.
static boolean	Same(java.lang.Object actual, java.lang.Object expected, java.lang.String customMessage) Assert an Object is the same object as the expected Object.
static void	setAbortOnFailure(boolean abortOnFailure) Default = false.
static boolean	True(boolean actual) Assert a boolean is true.
static boolean	True(boolean actual, java.lang.String customMessage) Assert a boolean is true.

Methods inherited from class java.lang.Object

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

Constructor Detail

Assert

protected Assert()

Protected Constructor for static class.

Method Detail

setAbortOnFailure

public static void setAbortOnFailure(boolean abortOnFailure)

Default = false. Set to true to cause any Assert test failure to signal a test Abort.

getAbortOnFailure

public static boolean getAbortOnFailure()

Returns:

the current state of the Abort On Failure flag.

incrementCounters

static void incrementCounters(boolean wasSuccessful)

Equals

public static boolean Equals(double actual,
                             double expected)

Assert two doubles or floats are equal using an absolute positive delta of 0.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Equals

public static boolean Equals(double actual,
                             double expected,
                             double delta)

Assert two doubles or floats are equal within an absolute positive delta.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Equals

public static boolean Equals(double actual,
                             double expected,
                             double delta,
                             java.lang.String customMessage)

Assert two doubles or floats are equal within an absolute positive delta. The user can provide a default custom failure message instead of using the default.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Equals

public static boolean Equals(long actual,
                             long expected)

Assert two longs or ints are equal.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Equals

public static boolean Equals(long actual,
                             long expected,
                             java.lang.String customMessage)

Assert two longs or ints are equal. The user can provide a default custom failure message instead of using the default.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Equals

public static boolean Equals(java.lang.Object actual,
                             java.lang.Object expected)

Assert two Objects are equal.

Returns:

true if both Objects are null, or actual.equals(expected).

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Equals

public static boolean Equals(java.lang.Object actual,
                             java.lang.Object expected,
                             java.lang.String customMessage)

Assert two Objects are equal. The user can provide a default custom failure message instead of using the default.

Returns:

true if both Objects are null, or actual.equals(expected).

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotEqual

public static boolean NotEqual(double actual,
                               double expected)

Assert two doubles or floats are NOT equal by an absolute positive delta of 0.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotEqual

public static boolean NotEqual(double actual,
                               double expected,
                               double delta)

Assert two doubles or floats are NOT equal by an absolute positive delta.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotEqual

public static boolean NotEqual(double actual,
                               double expected,
                               double delta,
                               java.lang.String customMessage)

Assert two doubles or floats are NOT equal by an absolute positive delta. The user can provide a default custom failure message instead of using the default.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotEqual

public static boolean NotEqual(long actual,
                               long expected)

Assert two longs or ints are NOT equal.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotEqual

public static boolean NotEqual(long actual,
                               long expected,
                               java.lang.String customMessage)

Assert two longs or ints are NOT equal. The user can provide a default custom failure message instead of using the default.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotEqual

public static boolean NotEqual(java.lang.Object actual,
                               java.lang.Object expected)

Assert two Objects are NOT equal.

Returns:

true if at least one of the Objects is not null, and actual.equals(expected) is false, or throws an Exception.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotEqual

public static boolean NotEqual(java.lang.Object actual,
                               java.lang.Object expected,
                               java.lang.String customMessage)

Assert two Objects are NOT equal. The user can provide a default custom failure message instead of using the default.

Returns:

true if at least one of the Objects is not null, and actual.equals(expected) is false, or throws an Exception.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotNull

public static boolean NotNull(java.lang.Object actual)

Assert an Objects is NOT null.

Returns:

true if the object is NOT null.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotNull

public static boolean NotNull(java.lang.Object actual,
                              java.lang.String customMessage)

Assert an Object is NOT null. The user can provide a default custom failure message instead of using the default.

Returns:

true if the object is NOT null.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Null

public static boolean Null(java.lang.Object actual)

Assert an Objects IS null.

Returns:

true if the object IS null.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Null

public static boolean Null(java.lang.Object actual,
                           java.lang.String customMessage)

Assert an Object IS null. The user can provide a default custom failure message instead of using the default.

Returns:

true if the object IS null.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Same

public static boolean Same(java.lang.Object actual,
                           java.lang.Object expected)

Assert an Object is the same object as the expected Object.

Returns:

true if both objects are null, or actual == expected.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

Same

public static boolean Same(java.lang.Object actual,
                           java.lang.Object expected,
                           java.lang.String customMessage)

Assert an Object is the same object as the expected Object. The user can provide a default custom failure message instead of using the default.

Returns:

true if both objects are null, or actual == expected.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotSame

public static boolean NotSame(java.lang.Object actual,
                              java.lang.Object expected)

Assert an Object is NOT the same object as the expected Object.

Returns:

true if at least one of the objects is not null, and actual != expected.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

NotSame

public static boolean NotSame(java.lang.Object actual,
                              java.lang.Object expected,
                              java.lang.String customMessage)

Assert an Object is NOT the same object as the expected Object. The user can provide a default custom failure message instead of using the default.

Returns:

true if at least one of the objects is not null, and actual != expected.

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

True

public static boolean True(boolean actual)

Assert a boolean is true.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

True

public static boolean True(boolean actual,
                           java.lang.String customMessage)

Assert a boolean is true. The user can provide a default custom failure message instead of using the default.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

False

public static boolean False(boolean actual)

Assert a boolean is false.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

False

public static boolean False(boolean actual,
                            java.lang.String customMessage)

Assert a boolean is false. The user can provide a default custom failure message instead of using the default.

Returns:

true on success, false on failure

Throws:

java.lang.RuntimeException - if abortOnFailure is true and the assertion fails.

fail

public static void fail()

Issue a generic test failure.

Throws:

java.lang.RuntimeException - if abortOnFailure is true.

fail

public static void fail(java.lang.String customMessage)

Issue a failure. The user can provide a default custom failure message instead of using the default.

Throws:

java.lang.RuntimeException - if abortOnFailure is true.