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
,AbstractBigIntegerAssert
,AbstractBooleanArrayAssert
,AbstractBooleanAssert
,AbstractByteArrayAssert
,AbstractByteAssert
,AbstractCharacterAssert
,AbstractCharArrayAssert
,AbstractCharSequenceAssert
,AbstractClassAssert
,AbstractComparableAssert
,AbstractCompletableFutureAssert
,AbstractDateAssert
,AbstractDoubleArrayAssert
,AbstractDoubleAssert
,AbstractDurationAssert
,AbstractEnumerableAssert
,AbstractFileAssert
,AbstractFloatArrayAssert
,AbstractFloatAssert
,AbstractFutureAssert
,AbstractInputStreamAssert
,AbstractInstantAssert
,AbstractIntArrayAssert
,AbstractIntegerAssert
,AbstractIterableAssert
,AbstractIterableSizeAssert
,AbstractIteratorAssert
,AbstractListAssert
,AbstractLocalDateAssert
,AbstractLocalDateTimeAssert
,AbstractLocalTimeAssert
,AbstractLongAdderAssert
,AbstractLongArrayAssert
,AbstractLongAssert
,AbstractMapAssert
,AbstractMapSizeAssert
,AbstractObjectArrayAssert
,AbstractObjectAssert
,AbstractOffsetDateTimeAssert
,AbstractOffsetTimeAssert
,AbstractOptionalAssert
,AbstractOptionalDoubleAssert
,AbstractOptionalIntAssert
,AbstractOptionalLongAssert
,AbstractPathAssert
,AbstractPeriodAssert
,AbstractPredicateAssert
,AbstractPredicateLikeAssert
,AbstractShortArrayAssert
,AbstractShortAssert
,AbstractSpliteratorAssert
,AbstractStringAssert
,AbstractTemporalAssert
,AbstractThrowableAssert
,AbstractUriAssert
,AbstractUrlAssert
,AbstractZonedDateTimeAssert
,AllOf
,AnyOf
,AtomicBooleanAssert
,AtomicIntegerArrayAssert
,AtomicIntegerAssert
,AtomicIntegerFieldUpdaterAssert
,AtomicLongArrayAssert
,AtomicLongAssert
,AtomicLongFieldUpdaterAssert
,AtomicMarkableReferenceAssert
,AtomicReferenceArrayAssert
,AtomicReferenceAssert
,AtomicReferenceFieldUpdaterAssert
,AtomicStampedReferenceAssert
,BigDecimalAssert
,BigIntegerAssert
,Boolean2DArrayAssert
,BooleanArrayAssert
,BooleanAssert
,Byte2DArrayAssert
,ByteArrayAssert
,ByteAssert
,Char2DArrayAssert
,CharacterAssert
,CharArrayAssert
,CharSequenceAssert
,ClassAssert
,ClassBasedNavigableIterableAssert
,ClassBasedNavigableListAssert
,CompletableFutureAssert
,Condition
,DateAssert
,DoesNotHave
,Double2DArrayAssert
,DoubleArrayAssert
,DoubleAssert
,DoublePredicateAssert
,DurationAssert
,FactoryBasedNavigableIterableAssert
,FactoryBasedNavigableListAssert
,FileAssert
,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
,MapSizeAssert
,Negative
,Not
,NotThrownAssert
,Object2DArrayAssert
,ObjectArrayAssert
,ObjectAssert
,OffsetDateTimeAssert
,OffsetTimeAssert
,OptionalAssert
,OptionalDoubleAssert
,OptionalIntAssert
,OptionalLongAssert
,PathAssert
,PeriodAssert
,PredicateAssert
,ProxyableClassAssert
,ProxyableIterableAssert
,ProxyableListAssert
,ProxyableMapAssert
,ProxyableObjectArrayAssert
,ProxyableObjectAssert
,ProxyablePredicateAssert
,RecursiveComparisonAssert
,Short2DArrayAssert
,ShortArrayAssert
,ShortAssert
,SpliteratorAssert
,StringAssert
,ThrowableAssert
,ThrowableAssertAlternative
,ThrowableTypeAssert
,UriAssert
,UrlAssert
,ZonedDateTimeAssert
public interface Descriptable<SELF>
An object that has a description.- Author:
- Alex Ruiz, Yvonne Wang, Mikhail Mazursky
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods 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.SELF
describedAs(Description description)
Sets the description of the assertion that is going to be called after.
-
-
-
Method Detail
-
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 isnull
.- See Also:
describedAs(String, Object...)
-
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 descriptionSupplier
.- Returns:
this
object.- Throws:
IllegalStateException
- if the descriptionSupplier isnull
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 isnull
.- See Also:
describedAs(Description)
-
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
since "as" is a keyword in Groovy.as(String, Object...)
- Parameters:
description
- the new description to set.args
- optional parameter if description is a format String.- Returns:
this
object.- Throws:
NullPointerException
- if the description isnull
.
-
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 isnull
.
-
-