|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.assertj.core.api.Condition<T>
T
- the type of object this condition accepts.public abstract class Condition<T>
A condition to be met by an object.
Constructor Summary | |
---|---|
Condition()
Creates a new Condition . |
|
Condition(Description description)
Creates a new Condition . |
|
Condition(String description)
Creates a new Condition . |
Method Summary | |
---|---|
Condition<T> |
as(Description newDescription)
Sets the description of this object. |
Condition<T> |
as(String newDescription,
Object... args)
Sets the description of this object supporting String.format(String, Object...) syntax. |
Condition<T> |
describedAs(Description newDescription)
Alias for since "as" is a keyword in Groovy. |
Condition<T> |
describedAs(String newDescription,
Object... args)
Alias for since "as" is a keyword in Groovy. |
Description |
description()
Returns the description of this condition. |
abstract boolean |
matches(T value)
Verifies that the given value satisfies this condition. |
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Condition()
Condition
. The default description of this condition will the simple name of the
condition's class.
public Condition(String description)
Condition
.
description
- the description of this condition.
NullPointerException
- if the given description is null
.public Condition(Description description)
Condition
.
description
- the description of this condition.
NullPointerException
- if the given description is null
.Method Detail |
---|
public Condition<T> describedAs(String newDescription, Object... args)
Descriptable.as(String, Object...)
since "as" is a keyword in Groovy.
describedAs
in interface Descriptable<Condition<T>>
newDescription
- the new description to set.
this
object.public Condition<T> as(String newDescription, Object... args)
String.format(String, Object...)
syntax.
Example :
try { // set a bad age to Mr Frodo which is really 33 years old. frodo.setAge(50); // you can specify a test description with as() method or describedAs(), it supports String format args 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]>"); }
as
in interface Descriptable<Condition<T>>
newDescription
- the new description to set.args
- optional parameter if description is a format String.
this
object.Descriptable.describedAs(String, Object...)
public Condition<T> describedAs(Description newDescription)
Descriptable.as(String, Object...)
since "as" is a keyword in Groovy. To remove or clear the description, pass a
EmptyTextDescription
as argument.
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.
describedAs
in interface Descriptable<Condition<T>>
newDescription
- the new description to set.
this
object.public Condition<T> as(Description newDescription)
EmptyTextDescription
as argument.
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.
as
in interface Descriptable<Condition<T>>
newDescription
- the new description to set.
this
object.Descriptable.describedAs(Description)
public Description description()
public abstract boolean matches(T value)
value
- the value to verify.
true
if the given value satisfies this condition; false
otherwise.public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |