Modifier and Type	Class and Description
public static enum	Condition.Status Describes the condition status after being evaluated.

Modifier and Type	Field and Description
pack-priv Description	description
private Predicate<T>	predicate

Constructor Summary

Access	Constructor and Description
public	Condition() Creates a new `Condition`.
public	Condition(String the description of this condition. description) Creates a new `Condition`.
public	Condition(Predicate<T> the `Predicate` used to build the condition. predicate, String the description of this condition. description, Object... optional parameter if description is a format String. args) Creates a new `Condition` with the given `Predicate`, the built Condition will be met if the Predicate is.
public	Condition(Description the description of this condition. description) Creates a new `Condition`.

Method Summary

Modifier and Type	Method and Description
private void	checkPredicate(Predicate<T> predicate)
public Description	Returns: the description of this condition with its status. conditionDescriptionWithStatus(T the instance to evaluate the condition status against. actual) Returns the description of this condition with its status failed or success.
public Condition<T>	describedAs(Description the new description to set. newDescription) Implements org.assertj.core.api.Descriptable.describedAs. Sets the description of the assertion that is going to be called after.
public Description	Returns: the description of this condition. description() Returns the description of this condition.
public boolean	Returns: `true` if the given value satisfies this condition; `false` otherwise. matches(T the value to verify. value) Verifies that the given value satisfies this condition.
protected Condition.Status	status(T actual)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

description	back to summary
pack-priv Description description Annotations @VisibleForTesting

predicate	back to summary
private Predicate<T> predicate

Constructor Detail

Condition	back to summary
public Condition() Creates a new `Condition`. The default description of this condition will the simple name of the condition's class.

Condition back to summary

Condition	back to summary
public Condition(String description) Creates a new `Condition`. Parameters description:String the description of this condition. Exceptions NullPointerException: if the given description is `null`.

public Condition(String description)

Creates a new Condition.

Parameters

description:String: the description of this condition.

Exceptions

NullPointerException:: if the given description is null.

Condition back to summary

Condition	back to summary
public Condition(Predicate<T> predicate, String description, Object... args) Creates a new `Condition` with the given `Predicate`, the built Condition will be met if the Predicate is. You must give a description, it will be used to build a nice error message when the condition fails, you can pass args to build the description as in `String#format(String, Object...)`. Example: `// build condition with Predicate<String> and set description using String#format pattern. Condition<String> fairyTale = new Condition<String>(s -> s.startsWith("Once upon a time"), "a %s tale", "fairy"); String littleRedCap = "Once upon a time there was a dear little girl ..."; assertThat(littleRedCap).is(fairyTale);` Error message example: `// unfortunately this assertion fails ... but contact me if you can make it pass :) assertThat("life").is(fairyTale); // error message Expecting: <"life"> to be <a fairy tale>` Parameters predicate:Predicate<T> the `Predicate` used to build the condition. description:String the description of this condition. args:Object[] optional parameter if description is a format String. Exceptions NullPointerException: if the given `Predicate` is `null`. if the given description is `null`.

public Condition(Predicate<T> predicate, String description, Object... args)

Creates a new Condition with the given Predicate, the built Condition will be met if the Predicate is.

You must give a description, it will be used to build a nice error message when the condition fails, you can pass args to build the description as in String#format(String, Object...).

Example:

 // build condition with Predicate<String> and set description using String#format pattern.
Condition<String> fairyTale = new Condition<String>(s -> s.startsWith("Once upon a time"), "a %s tale", "fairy");

String littleRedCap = "Once upon a time there was a dear little girl ...";
assertThat(littleRedCap).is(fairyTale);

Error message example:

 // unfortunately this assertion fails ... but contact me if you can make it pass :)
assertThat("life").is(fairyTale);
// error message
Expecting:
 <"life">
to be <a fairy tale>

Parameters

predicate:Predicate<T>: the Predicate used to build the condition.
description:String: the description of this condition.
args:Object[]: optional parameter if description is a format String.

Exceptions

NullPointerException:

if the given Predicate is null.
if the given description is null.

Condition back to summary

Condition	back to summary
public Condition(Description description) Creates a new `Condition`. Parameters description:Description the description of this condition. Exceptions NullPointerException: if the given description is `null`.

public Condition(Description description)

Creates a new Condition.

Parameters

description:Description: the description of this condition.

Exceptions

NullPointerException:: if the given description is null.

Method Detail

checkPredicate	back to summary
private void checkPredicate(Predicate<T> predicate)

conditionDescriptionWithStatus	back to summary
public Description conditionDescriptionWithStatus(T actual) Returns the description of this condition with its status failed or success. Parameters actual:T the instance to evaluate the condition status against. Returns:Description the description of this condition with its status.

conditionDescriptionWithStatus

back to summary

public Description conditionDescriptionWithStatus(T actual)

Returns the description of this condition with its status failed or success.

Parameters

actual:T: the instance to evaluate the condition status against.

Returns:Description

the description of this condition with its status.

describedAs back to summary

describedAs	back to summary
public Condition<T> describedAs(Description newDescription) Implements org.assertj.core.api.Descriptable.describedAs. Doc from org.assertj.core.api.Descriptable.describedAs. 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 newDescription:Description the new description to set. Returns:Condition<T> `this` object. Annotations @Override

public Condition<T> describedAs(Description newDescription)

Implements org.assertj.core.api.Descriptable.describedAs.

Doc from org.assertj.core.api.Descriptable.describedAs.

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

newDescription:Description: the new description to set.

Returns:Condition<T>

this object.

Annotations

@Override

description	back to summary
public Description description() Returns the description of this condition. Returns:Description the description of this condition.

description

back to summary

public Description description()

Returns the description of this condition.

Returns:Description: the description of this condition.

matches back to summary

matches	back to summary
public boolean matches(T value) Verifies that the given value satisfies this condition. Parameters value:T the value to verify. Returns:boolean `true` if the given value satisfies this condition; `false` otherwise.

public boolean matches(T value)

Verifies that the given value satisfies this condition.

Parameters

value:T: the value to verify.

Returns:boolean

true if the given value satisfies this condition; false otherwise.

status	back to summary
protected Condition.Status status(T actual)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

org.assertj.core.api back to summary

public final Enum Condition.Status

Class Inheritance

extends Enum<Condition.Status>

java.lang.Object
java.lang.Enum
org.assertj.core.api.Condition.Status

Describes the condition status after being evaluated.

Field Summary

Modifier and Type	Field and Description
public static final Condition.Status	FAIL
public final String	label
public static final Condition.Status	SUCCESS

Constructor Summary

Access	Constructor and Description
private	Status(String label)

Method Summary

Modifier and Type	Method and Description
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static Condition.Status	valueOf(String name)
public static Condition.Status[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal valueOf

Field Detail

FAIL	back to summary
public static final Condition.Status FAIL

label	back to summary
public final String label

SUCCESS	back to summary
public static final Condition.Status SUCCESS

Constructor Detail

Status	back to summary
private Status(String label)

Method Detail

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Returns:String the name of this enum constant Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations

@Override

valueOf	back to summary
public static Condition.Status valueOf(String name)

values	back to summary
public static Condition.Status[] values()

public Class Condition<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Condition.Status

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail