Top Description Inners Constructors Methods
org.testng.asserts

public Class Assertion

extends Object
implements IAssertLifecycle
Class Inheritance
All Implemented Interfaces
org.testng.asserts.IAssertLifecycle
Known Direct Subclasses
org.testng.asserts.LoggingAssert, org.testng.asserts.SoftAssert
Imports
java.util.Collection, .Map, .Set

An assert class with various hooks allowing its behavior to be modified by subclasses.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private abstract static class

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public <T> void
assertEquals(final T actual, final T expected, final String message)

public <T> void
assertEquals(final T actual, final T expected)

public void
assertEquals(final String actual, final String expected, final String message)

public void
assertEquals(final String actual, final String expected)

public void
assertEquals(final double actual, final double expected, final double delta, final String message)

public void
assertEquals(final double actual, final double expected, final double delta)

public void
assertEquals(final float actual, final float expected, final float delta, final String message)

public void
assertEquals(final float actual, final float expected, final float delta)

public void
assertEquals(final long actual, final long expected, final String message)

public void
assertEquals(final long actual, final long expected)

public void
assertEquals(final boolean actual, final boolean expected, final String message)

public void
assertEquals(final boolean actual, final boolean expected)

public void
assertEquals(final byte actual, final byte expected, final String message)

public void
assertEquals(final byte actual, final byte expected)

public void
assertEquals(final char actual, final char expected, final String message)

public void
assertEquals(final char actual, final char expected)

public void
assertEquals(final short actual, final short expected, final String message)

public void
assertEquals(final short actual, final short expected)

public void
assertEquals(final int actual, final int expected, final String message)

public void
assertEquals(final int actual, final int expected)

public void
assertEquals(final Collection<?> actual, final Collection<?> expected)

public void
assertEquals(final Collection<?> actual, final Collection<?> expected, final String message)

public void
assertEquals(final Object[] actual, final Object[] expected, final String message)

public void
assertEquals(final Object[] actual, final Object[] expected)

public void
assertEquals(final byte[] actual, final byte[] expected)

public void
assertEquals(final byte[] actual, final byte[] expected, final String message)

public void
assertEquals(final Set<?> actual, final Set<?> expected)

public void
assertEquals(final Set<?> actual, final Set<?> expected, final String message)

public void
assertEquals(final Map<?, ?> actual, final Map<?, ?> expected)

public void
assertEqualsNoOrder(final Object[] actual, final Object[] expected, final String message)

public void
assertEqualsNoOrder(final Object[] actual, final Object[] expected)

public void
assertFalse(final boolean condition, final String message)

public void
assertFalse(final boolean condition)

public void
assertNotEquals(final Object actual, final Object expected, final String message)

public void
assertNotEquals(final Object actual, final Object expected)

public void
assertNotEquals(final String actual, final String expected, final String message)

public void
assertNotEquals(final String actual, final String expected)

public void
assertNotEquals(final long actual, final long expected, final String message)

public void
assertNotEquals(final long actual, final long expected)

public void
assertNotEquals(final boolean actual, final boolean expected, final String message)

public void
assertNotEquals(final boolean actual, final boolean expected)

public void
assertNotEquals(final byte actual, final byte expected, final String message)

public void
assertNotEquals(final byte actual, final byte expected)

public void
assertNotEquals(final char actual, final char expected, final String message)

public void
assertNotEquals(final char actual, final char expected)

public void
assertNotEquals(final short actual, final short expected, final String message)

public void
assertNotEquals(final short actual, final short expected)

public void
assertNotEquals(final int actual, final int expected, final String message)

public void
assertNotEquals(final int actual, final int expected)

public void
assertNotEquals(final float actual, final float expected, final float delta, final String message)

public void
assertNotEquals(final float actual, final float expected, final float delta)

public void
assertNotEquals(final double actual, final double expected, final double delta, final String message)

public void
assertNotEquals(final double actual, final double expected, final double delta)

public void
assertNotNull(final Object object)

public void
assertNotNull(final Object object, final String message)

public void
assertNotSame(final Object actual, final Object expected, final String message)

public void
assertNotSame(final Object actual, final Object expected)

public void
assertNull(final Object object)

public void
assertNull(final Object object, final String message)

public void
assertSame(final Object actual, final Object expected, final String message)

public void
assertSame(final Object actual, final Object expected)

public void
assertTrue(final boolean condition, final String message)

public void
assertTrue(final boolean condition)

protected void
doAssert(IAssert<?> assertCommand)

public void
executeAssert(IAssert<?>
The assertion
assertCommand
)

Implements org.testng.asserts.IAssertLifecycle.executeAssert.

Run the assert command in parameter.
public void
fail(final String message, final Throwable realCause)

public void
fail(final String message)

public void
fail()

protected String

Returns:

default throwable formatted message for TestNG
getErrorDetails
(Throwable
Throwable of the Assertion
error
)

* Override this method should you want to change the default way Throwable objects are logged.

public void
onAfterAssert(IAssert<?>
The assertion
assertCommand
)

Implements org.testng.asserts.IAssertLifecycle.onAfterAssert.

Invoked after an assert is run.
public void
onAssertFailure(IAssert<?>
The assertion
assertCommand
,
AssertionError
The error
ex
)

Implements org.testng.asserts.IAssertLifecycle.onAssertFailure.

Invoked when an assert fails.
public void
onAssertSuccess(IAssert<?>
The assertion
assertCommand
)

Implements org.testng.asserts.IAssertLifecycle.onAssertSuccess.

Invoked when an assert succeeds.
public void
onBeforeAssert(IAssert<?>
The assertion
assertCommand
)

Implements org.testng.asserts.IAssertLifecycle.onBeforeAssert.

Invoked before an assert is run.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Assertionback to summary
public Assertion()

Method Detail

assertEqualsback to summary
public <T> void assertEquals(final T actual, final T expected, final String message)
assertEqualsback to summary
public <T> void assertEquals(final T actual, final T expected)
assertEqualsback to summary
public void assertEquals(final String actual, final String expected, final String message)
assertEqualsback to summary
public void assertEquals(final String actual, final String expected)
assertEqualsback to summary
public void assertEquals(final double actual, final double expected, final double delta, final String message)
assertEqualsback to summary
public void assertEquals(final double actual, final double expected, final double delta)
assertEqualsback to summary
public void assertEquals(final float actual, final float expected, final float delta, final String message)
assertEqualsback to summary
public void assertEquals(final float actual, final float expected, final float delta)
assertEqualsback to summary
public void assertEquals(final long actual, final long expected, final String message)
assertEqualsback to summary
public void assertEquals(final long actual, final long expected)
assertEqualsback to summary
public void assertEquals(final boolean actual, final boolean expected, final String message)
assertEqualsback to summary
public void assertEquals(final boolean actual, final boolean expected)
assertEqualsback to summary
public void assertEquals(final byte actual, final byte expected, final String message)
assertEqualsback to summary
public void assertEquals(final byte actual, final byte expected)
assertEqualsback to summary
public void assertEquals(final char actual, final char expected, final String message)
assertEqualsback to summary
public void assertEquals(final char actual, final char expected)
assertEqualsback to summary
public void assertEquals(final short actual, final short expected, final String message)
assertEqualsback to summary
public void assertEquals(final short actual, final short expected)
assertEqualsback to summary
public void assertEquals(final int actual, final int expected, final String message)
assertEqualsback to summary
public void assertEquals(final int actual, final int expected)
assertEqualsback to summary
public void assertEquals(final Collection<?> actual, final Collection<?> expected)
assertEqualsback to summary
public void assertEquals(final Collection<?> actual, final Collection<?> expected, final String message)
assertEqualsback to summary
public void assertEquals(final Object[] actual, final Object[] expected, final String message)
assertEqualsback to summary
public void assertEquals(final Object[] actual, final Object[] expected)
assertEqualsback to summary
public void assertEquals(final byte[] actual, final byte[] expected)
assertEqualsback to summary
public void assertEquals(final byte[] actual, final byte[] expected, final String message)
assertEqualsback to summary
public void assertEquals(final Set<?> actual, final Set<?> expected)
assertEqualsback to summary
public void assertEquals(final Set<?> actual, final Set<?> expected, final String message)
assertEqualsback to summary
public void assertEquals(final Map<?, ?> actual, final Map<?, ?> expected)
assertEqualsNoOrderback to summary
public void assertEqualsNoOrder(final Object[] actual, final Object[] expected, final String message)
assertEqualsNoOrderback to summary
public void assertEqualsNoOrder(final Object[] actual, final Object[] expected)
assertFalseback to summary
public void assertFalse(final boolean condition, final String message)
assertFalseback to summary
public void assertFalse(final boolean condition)
assertNotEqualsback to summary
public void assertNotEquals(final Object actual, final Object expected, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final Object actual, final Object expected)
assertNotEqualsback to summary
public void assertNotEquals(final String actual, final String expected, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final String actual, final String expected)
assertNotEqualsback to summary
public void assertNotEquals(final long actual, final long expected, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final long actual, final long expected)
assertNotEqualsback to summary
public void assertNotEquals(final boolean actual, final boolean expected, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final boolean actual, final boolean expected)
assertNotEqualsback to summary
public void assertNotEquals(final byte actual, final byte expected, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final byte actual, final byte expected)
assertNotEqualsback to summary
public void assertNotEquals(final char actual, final char expected, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final char actual, final char expected)
assertNotEqualsback to summary
public void assertNotEquals(final short actual, final short expected, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final short actual, final short expected)
assertNotEqualsback to summary
public void assertNotEquals(final int actual, final int expected, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final int actual, final int expected)
assertNotEqualsback to summary
public void assertNotEquals(final float actual, final float expected, final float delta, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final float actual, final float expected, final float delta)
assertNotEqualsback to summary
public void assertNotEquals(final double actual, final double expected, final double delta, final String message)
assertNotEqualsback to summary
public void assertNotEquals(final double actual, final double expected, final double delta)
assertNotNullback to summary
public void assertNotNull(final Object object)
assertNotNullback to summary
public void assertNotNull(final Object object, final String message)
assertNotSameback to summary
public void assertNotSame(final Object actual, final Object expected, final String message)
assertNotSameback to summary
public void assertNotSame(final Object actual, final Object expected)
assertNullback to summary
public void assertNull(final Object object)
assertNullback to summary
public void assertNull(final Object object, final String message)
assertSameback to summary
public void assertSame(final Object actual, final Object expected, final String message)
assertSameback to summary
public void assertSame(final Object actual, final Object expected)
assertTrueback to summary
public void assertTrue(final boolean condition, final String message)
assertTrueback to summary
public void assertTrue(final boolean condition)
doAssertback to summary
protected void doAssert(IAssert<?> assertCommand)
executeAssertback to summary
public void executeAssert(IAssert<?> assertCommand)

Implements org.testng.asserts.IAssertLifecycle.executeAssert.

Run the assert command in parameter. Meant to be overridden by subclasses.

Parameters
assertCommand:IAssert<?>

Doc from org.testng.asserts.IAssertLifecycle.executeAssert.

The assertion

Annotations
@Override
failback to summary
public void fail(final String message, final Throwable realCause)
failback to summary
public void fail(final String message)
failback to summary
public void fail()
getErrorDetailsback to summary
protected String getErrorDetails(Throwable error)

* Override this method should you want to change the default way Throwable objects are logged.

Parameters
error:Throwable

Throwable of the Assertion

Returns:String

default throwable formatted message for TestNG

onAfterAssertback to summary
public void onAfterAssert(IAssert<?> assertCommand)

Implements org.testng.asserts.IAssertLifecycle.onAfterAssert.

Invoked after an assert is run. Meant to be overridden by subclasses.

Parameters
assertCommand:IAssert<?>

Doc from org.testng.asserts.IAssertLifecycle.onAfterAssert.

The assertion

Annotations
@Override
onAssertFailureback to summary
public void onAssertFailure(IAssert<?> assertCommand, AssertionError ex)

Implements org.testng.asserts.IAssertLifecycle.onAssertFailure.

Doc from org.testng.asserts.IAssertLifecycle.onAssertFailure.

Invoked when an assert fails.

Parameters
assertCommand:IAssert<?>

The assertion

ex:AssertionError

The error

Annotations
@Override
onAssertSuccessback to summary
public void onAssertSuccess(IAssert<?> assertCommand)

Implements org.testng.asserts.IAssertLifecycle.onAssertSuccess.

Invoked when an assert succeeds. Meant to be overridden by subclasses.

Parameters
assertCommand:IAssert<?>

Doc from org.testng.asserts.IAssertLifecycle.onAssertSuccess.

The assertion

Annotations
@Override
onBeforeAssertback to summary
public void onBeforeAssert(IAssert<?> assertCommand)

Implements org.testng.asserts.IAssertLifecycle.onBeforeAssert.

Invoked before an assert is run. Meant to be overridden by subclasses.

Parameters
assertCommand:IAssert<?>

Doc from org.testng.asserts.IAssertLifecycle.onBeforeAssert.

The assertion

Annotations
@Override
org.testng.asserts back to summary

private abstract Class Assertion.SimpleAssert<T>

extends Object
implements IAssert<T>
Class Inheritance
All Implemented Interfaces
org.testng.asserts.IAssert

Field Summary

Modifier and TypeField and Description
private final T
private final T
private final String

Constructor Summary

AccessConstructor and Description
public
public
SimpleAssert(T actual, T expected)

public
SimpleAssert(T actual, T expected, String message)

Method Summary

Modifier and TypeMethod and Description
public abstract void
public T
public T
public String
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actualback to summary
private final T actual
expectedback to summary
private final T expected
m_messageback to summary
private final String m_message

Constructor Detail

SimpleAssertback to summary
public SimpleAssert(String message)
SimpleAssertback to summary
public SimpleAssert(T actual, T expected)
SimpleAssertback to summary
public SimpleAssert(T actual, T expected, String message)

Method Detail

doAssertback to summary
public abstract void doAssert()

Redeclares org.testng.asserts.IAssert.doAssert.

Annotations
@Override
getActualback to summary
public T getActual()

Implements org.testng.asserts.IAssert.getActual.

Annotations
@Override
getExpectedback to summary
public T getExpected()

Implements org.testng.asserts.IAssert.getExpected.

Annotations
@Override
getMessageback to summary
public String getMessage()

Implements org.testng.asserts.IAssert.getMessage.

Annotations
@Override