Package org.assertj.core.api

Interface Descriptable<SELF>

Type Parameters:
SELF - the "self" type of this assertion class.
All Known Subinterfaces:
Assert<SELF,ACTUAL>
All Known Implementing Classes:
Abstract2DArrayAssert, AbstractArrayAssert, AbstractAssert, AbstractAtomicFieldUpdaterAssert, AbstractAtomicReferenceAssert, AbstractBigDecimalAssert, AbstractBigDecimalScaleAssert, AbstractBigIntegerAssert, AbstractBooleanArrayAssert, AbstractBooleanAssert, AbstractByteArrayAssert, AbstractByteAssert, AbstractCharacterAssert, AbstractCharArrayAssert, AbstractCharSequenceAssert, AbstractClassAssert, AbstractCollectionAssert, AbstractComparableAssert, AbstractCompletableFutureAssert, AbstractDateAssert, AbstractDoubleArrayAssert, AbstractDoubleAssert, AbstractDurationAssert, AbstractEnumerableAssert, AbstractFileAssert, AbstractFileSizeAssert, AbstractFloatArrayAssert, AbstractFloatAssert, AbstractFutureAssert, AbstractInputStreamAssert, AbstractInstantAssert, AbstractIntArrayAssert, AbstractIntegerAssert, AbstractIterableAssert, AbstractIterableSizeAssert, AbstractIteratorAssert, AbstractListAssert, AbstractLocalDateAssert, AbstractLocalDateTimeAssert, AbstractLocalTimeAssert, AbstractLongAdderAssert, AbstractLongArrayAssert, AbstractLongAssert, AbstractMapAssert, AbstractMapSizeAssert, AbstractMatcherAssert, AbstractObjectArrayAssert, AbstractObjectAssert, AbstractOffsetDateTimeAssert, AbstractOffsetTimeAssert, AbstractOptionalAssert, AbstractOptionalDoubleAssert, AbstractOptionalIntAssert, AbstractOptionalLongAssert, AbstractPathAssert, AbstractPeriodAssert, AbstractPredicateAssert, AbstractShortArrayAssert, AbstractShortAssert, AbstractSpliteratorAssert, AbstractStringAssert, AbstractTemporalAssert, AbstractThrowableAssert, AbstractUniversalComparableAssert, AbstractUriAssert, AbstractUrlAssert, AbstractZonedDateTimeAssert, AllOf, AnyOf, AtomicBooleanAssert, AtomicIntegerArrayAssert, AtomicIntegerAssert, AtomicIntegerFieldUpdaterAssert, AtomicLongArrayAssert, AtomicLongAssert, AtomicLongFieldUpdaterAssert, AtomicMarkableReferenceAssert, AtomicReferenceArrayAssert, AtomicReferenceAssert, AtomicReferenceFieldUpdaterAssert, AtomicStampedReferenceAssert, BigDecimalAssert, BigDecimalScaleAssert, BigIntegerAssert, Boolean2DArrayAssert, BooleanArrayAssert, BooleanAssert, Byte2DArrayAssert, ByteArrayAssert, ByteAssert, Char2DArrayAssert, CharacterAssert, CharArrayAssert, CharSequenceAssert, ClassAssert, ClassBasedNavigableIterableAssert, ClassBasedNavigableListAssert, CollectionAssert, CompletableFutureAssert, Condition, DateAssert, DoesNotHave, Double2DArrayAssert, DoubleArrayAssert, DoubleAssert, DoublePredicateAssert, DurationAssert, FactoryBasedNavigableIterableAssert, FactoryBasedNavigableListAssert, FileAssert, FileSizeAssert, Float2DArrayAssert, FloatArrayAssert, FloatAssert, FutureAssert, GenericComparableAssert, HamcrestCondition, InputStreamAssert, InstantAssert, Int2DArrayAssert, IntArrayAssert, IntegerAssert, IntPredicateAssert, IterableAssert, IterableSizeAssert, IteratorAssert, Join, ListAssert, LocalDateAssert, LocalDateTimeAssert, LocalTimeAssert, Long2DArrayAssert, LongAdderAssert, LongArrayAssert, LongAssert, LongPredicateAssert, MapAssert, MappedCondition, MapSizeAssert, MatcherAssert, Negative, NestableCondition, Not, NotThrownAssert, Object2DArrayAssert, ObjectArrayAssert, ObjectAssert, OffsetDateTimeAssert, OffsetTimeAssert, OptionalAssert, OptionalDoubleAssert, OptionalIntAssert, OptionalLongAssert, PathAssert, PeriodAssert, PredicateAssert, RecursiveAssertionAssert, RecursiveComparisonAssert, Short2DArrayAssert, ShortArrayAssert, ShortAssert, SoftThrowableAssertAlternative, SoftThrowableTypeAssert, SpliteratorAssert, StringAssert, ThrowableAssert, ThrowableAssertAlternative, ThrowableTypeAssert, UniversalComparableAssert, UriAssert, UrlAssert, VerboseCondition, ZonedDateTimeAssert
public interface Descriptable<SELF>
An object that has a description.
Author:
Alex Ruiz, Yvonne Wang, Mikhail Mazursky

  • Method Summary

    Modifier and Type
    Method
    Description
    default SELF
    as(String description, Object... args)
    Sets the description of the assertion that is going to be called after.
    default SELF
    as(Supplier<String> descriptionSupplier)
    Lazily specifies the description of the assertion that is going to be called, the given description is not evaluated if the assertion succeeds.
    default SELF
    as(Description description)
    Sets the description of the assertion that is going to be called after.
    default SELF
    describedAs(String description, Object... args)
    Sets the description of the assertion that is going to be called after.
    default SELF
    describedAs(Supplier<String> descriptionSupplier)
    Lazily specifies the description of the assertion that is going to be called, the given description is not evaluated if the assertion succeeds.
    SELF
    describedAs(Description description)
    Sets the description of the assertion that is going to be called after.

  • Method Details

    • as

      default SELF 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 an incorrect 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]\n
                             expected: 33\n
                              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:

    • as

      default SELF as(Supplier<String> descriptionSupplier)
      Lazily specifies the description of the assertion that is going to be called, the given description is not evaluated if the assertion succeeds.

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

      Example : 

       // set an incorrect age to Mr Frodo which we all know is 33 years old.
 frodo.setAge(50);

 // the lazy test description is not evaluated as the assertion succeeds
 assertThat(frodo.getAge()).as(() -> "check Frodo's age").isEqualTo(50);

 try
 {
   // the lazy test description is evaluated as the assertion fails
   assertThat(frodo.getAge()).as(() -> "check Frodo's age").isEqualTo(33);
 }
 catch (AssertionError e)
 {
   assertThat(e).hasMessage("[check Frodo's age]\n
                             expected: 33\n
                              but was: 50");
 }
      Parameters:
      descriptionSupplier - the description Supplier.
      Returns:
      this object.
      Throws:
      IllegalStateException - if the descriptionSupplier is null when evaluated.

    • as

      default SELF 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

      default SELF 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.
      args - optional parameter if description is a format String.
      Returns:
      this object.
      Throws:
      NullPointerException - if the description is null.

    • describedAs

      default SELF describedAs(Supplier<String> descriptionSupplier)
      Lazily specifies the description of the assertion that is going to be called, the given description is not evaluated if the assertion succeeds.

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

      Example : 

       // set an incorrect age to Mr Frodo which we all know is 33 years old.
 frodo.setAge(50);

 // the lazy test description is not evaluated as the assertion succeeds
 assertThat(frodo.getAge()).as(() -> "check Frodo's age").isEqualTo(50);

 try
 {
   // the lazy test description is evaluated as the assertion fails
   assertThat(frodo.getAge()).as(() -> "check Frodo's age").isEqualTo(33);
 }
 catch (AssertionError e)
 {
   assertThat(e).hasMessage("[check Frodo's age]\n
                             expected: 33\n
                              but was: 50");
 }
      Parameters:
      descriptionSupplier - the description Supplier.
      Returns:
      this object.
      Throws:
      IllegalStateException - if the descriptionSupplier is null when evaluated.

    • describedAs

      SELF 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.