org.assertj.core.api

Interface Descriptable<S extends Descriptable<S>>

Type Parameters:

S - the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation" for more details.

All Known Subinterfaces:

Assert<S,A>

All Known Implementing Classes:

AbstractArrayAssert, AbstractAssert, AbstractBigDecimalAssert, AbstractBooleanArrayAssert, AbstractBooleanAssert, AbstractByteArrayAssert, AbstractByteAssert, AbstractCharacterAssert, AbstractCharArrayAssert, AbstractCharSequenceAssert, AbstractClassAssert, AbstractComparableAssert, AbstractDateAssert, AbstractDoubleArrayAssert, AbstractDoubleAssert, AbstractEnumerableAssert, AbstractFileAssert, AbstractFloatArrayAssert, AbstractFloatAssert, AbstractInputStreamAssert, AbstractIntArrayAssert, AbstractIntegerAssert, AbstractIterableAssert, AbstractIterableSizeAssert, AbstractListAssert, AbstractLongArrayAssert, AbstractLongAssert, AbstractMapAssert, AbstractMapSizeAssert, AbstractObjectArrayAssert, AbstractObjectAssert, AbstractPathAssert, AbstractShortArrayAssert, AbstractShortAssert, AbstractThrowableAssert, AbstractUriAssert, AbstractUrlAssert, AllOf, AnyOf, BigDecimalAssert, BooleanArrayAssert, BooleanAssert, ByteArrayAssert, ByteAssert, CharacterAssert, CharArrayAssert, CharSequenceAssert, ClassAssert, ClassBasedNavigableIterableAssert, ClassBasedNavigableListAssert, Condition, DateAssert, DoesNotHave, DoubleArrayAssert, DoubleAssert, FactoryBasedNavigableIterableAssert, FactoryBasedNavigableListAssert, FileAssert, FloatArrayAssert, FloatAssert, GenericComparableAssert, InputStreamAssert, IntArrayAssert, IntegerAssert, IterableAssert, IterableSizeAssert, Join, ListAssert, LongArrayAssert, LongAssert, MapAssert, MapSizeAssert, Negative, Not, ObjectArrayAssert, ObjectAssert, PathAssert, ShortArrayAssert, ShortAssert, SoftAssertionClassAssert, SoftAssertionMapAssert, StringAssert, ThrowableAssert, UriAssert, UrlAssert

public interface Descriptable<S extends Descriptable<S>>

An object that has a description.

Author:

Alex Ruiz, Yvonne Wang, Mikhail Mazursky

Method Summary

Methods

Modifier and Type	Method and Description
S	as(Description description) Sets the description of the assertion that is going to be called after.
S	as(String description, Object... args) Sets the description of the assertion that is going to be called after.
S	describedAs(Description description) Sets the description of the assertion that is going to be called after.
S	describedAs(String description, Object... args) Sets the description of the assertion that is going to be called after.

Method Detail

as

S as(String description,
   Object... args)

Sets the description of the assertion that is going to be called after.

You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.

The description follows String.format(String, Object...) syntax.

Example :

 try {
   // set a bad age to Mr Frodo which is really 33 years old.
   frodo.setAge(50);
   // specify a test description (call as() before the assertion !), it supports String format syntax.
   assertThat(frodo.getAge()).as("check %s's age", frodo.getName()).isEqualTo(33);
 } catch (AssertionError e) {
   assertThat(e).hasMessage("[check Frodo's age] expected:<[33]> but was:<[50]>");
 }

Parameters:

description - the new description to set.

args - optional parameter if description is a format String.

Returns:

this object.

Throws:

NullPointerException - if the description is null.

See Also:

describedAs(String, Object...)

as

S as(Description description)

Sets the description of the assertion that is going to be called after.

You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.

This overloaded version of "describedAs" offers more flexibility than the one taking a String by allowing users to pass their own implementation of a description. For example, a description that creates its value lazily, only when an assertion failure occurs.

Parameters:

description - the new description to set.

Returns:

this object.

Throws:

NullPointerException - if the description is null.

See Also:

describedAs(Description)

describedAs

S describedAs(String description,
            Object... args)

Sets the description of the assertion that is going to be called after.

You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.

Alias for as(String, Object...) since "as" is a keyword in Groovy.

Parameters:

description - the new description to set.

Returns:

this object.

Throws:

NullPointerException - if the description is null.

describedAs

S describedAs(Description description)

Sets the description of the assertion that is going to be called after.

You must set it before calling the assertion otherwise it is ignored as the failing assertion breaks the chained call by throwing an AssertionError.

This overloaded version of "describedAs" offers more flexibility than the one taking a String by allowing users to pass their own implementation of a description. For example, a description that creates its value lazily, only when an assertion failure occurs.

Parameters:

description - the new description to set.

Returns:

this object.

Throws:

NullPointerException - if the description is null.