AssertJ Core 3.26.0 · org.assertj.core.api.WritableAssertionInfo

Modifier and Type	Field and Description
private Description	description
private static final String	EMPTY_STRING
private String	overridingErrorMessage
private Supplier<String>	overridingErrorMessageSupplier
private Representation	representation

Access	Constructor and Description
public	WritableAssertionInfo(Representation customRepresentation)
public	WritableAssertionInfo()

Method Summary

Modifier and Type	Method and Description
public Description	description() Implements org.assertj.core.api.AssertionInfo.description. Returns the description of an assertion.
public void	description(String the new description. newDescription, Object... if `newDescription` is a format String, `args` is argument of `String#format(String, Object...)` args) Sets the description of an assertion, if given null an empty `Description` is set.
public void	description(Description the new description. newDescription) Sets the description of an assertion, if given null an empty `Description` is set.
public String	Returns: the text of this object's description. descriptionText() Returns the text of this object's description, it is an empty String if no description was set.
public boolean	Returns: whether the text of this object's description was set. hasDescription() Returns whether the text of this object's description was set.
public static String	mostRelevantDescriptionIn(WritableAssertionInfo info, String newDescription)
public String	overridingErrorMessage() Implements org.assertj.core.api.AssertionInfo.overridingErrorMessage. Returns the message that, if specified, will replace the default message of an assertion failure.
public void	overridingErrorMessage(String the new message. It can be `null`. newErrorMessage) Sets the message that will replace the default message of an assertion failure.
public void	overridingErrorMessage(Supplier<String> the new message by a supplier. It can be `null`. supplier) Sets the lazy fail message that will replace the default message of an assertion failure by using a supplier.
public Representation	representation() Implements org.assertj.core.api.AssertionInfo.representation.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public void	useBinaryRepresentation()
public void	useHexadecimalRepresentation()
public void	useRepresentation(Representation newRepresentation)
public void	useUnicodeRepresentation()

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

description	back to summary
private Description description

EMPTY_STRING	back to summary
private static final String EMPTY_STRING

overridingErrorMessage	back to summary
private String overridingErrorMessage

overridingErrorMessageSupplier	back to summary
private Supplier<String> overridingErrorMessageSupplier

representation	back to summary
private Representation representation

WritableAssertionInfo	back to summary
public WritableAssertionInfo(Representation customRepresentation)

WritableAssertionInfo	back to summary
public WritableAssertionInfo()

Method Detail

description	back to summary
public Description description() Implements org.assertj.core.api.AssertionInfo.description. Doc from org.assertj.core.api.AssertionInfo.description. Returns the description of an assertion. Returns:Description the description of an assertion. Annotations @Override

description

back to summary

public Description description()

Implements org.assertj.core.api.AssertionInfo.description.

Doc from org.assertj.core.api.AssertionInfo.description.

Returns the description of an assertion.

Returns:Description

the description of an assertion.

Annotations

@Override

description back to summary

description	back to summary
public void description(String newDescription, Object... args) Sets the description of an assertion, if given null an empty `Description` is set. Parameters newDescription:String the new description. args:Object[] if `newDescription` is a format String, `args` is argument of `String#format(String, Object...)` See Also `description(Description)`

public void description(String newDescription, Object... args)

Sets the description of an assertion, if given null an empty Description is set.

Parameters

newDescription:String: the new description.
args:Object[]: if newDescription is a format String, args is argument of String#format(String, Object...)

See Also

description(Description)

description back to summary

description	back to summary
public void description(Description newDescription) Sets the description of an assertion, if given null an empty `Description` is set. To remove or clear the description, pass a `EmptyTextDescription` as argument. Parameters newDescription:Description the new description.

public void description(Description newDescription)

Sets the description of an assertion, if given null an empty Description is set.

To remove or clear the description, pass a EmptyTextDescription as argument.

Parameters

newDescription:Description: the new description.

descriptionText	back to summary
public String descriptionText() Returns the text of this object's description, it is an empty String if no description was set. Returns:String the text of this object's description.

descriptionText

back to summary

public String descriptionText()

Returns the text of this object's description, it is an empty String if no description was set.

Returns:String: the text of this object's description.

hasDescription	back to summary
public boolean hasDescription() Returns whether the text of this object's description was set. Returns:boolean whether the text of this object's description was set.

hasDescription

back to summary

public boolean hasDescription()

Returns whether the text of this object's description was set.

Returns:boolean: whether the text of this object's description was set.

mostRelevantDescriptionIn	back to summary
public static String mostRelevantDescriptionIn(WritableAssertionInfo info, String newDescription)

overridingErrorMessage	back to summary
public String overridingErrorMessage() Implements org.assertj.core.api.AssertionInfo.overridingErrorMessage. Doc from org.assertj.core.api.AssertionInfo.overridingErrorMessage. Returns the message that, if specified, will replace the default message of an assertion failure. Returns:String the message that, if specified, will replace the default message of an assertion failure. Annotations @Override

overridingErrorMessage

back to summary

public String overridingErrorMessage()

Implements org.assertj.core.api.AssertionInfo.overridingErrorMessage.

Doc from org.assertj.core.api.AssertionInfo.overridingErrorMessage.

Returns the message that, if specified, will replace the default message of an assertion failure.

Returns:String

the message that, if specified, will replace the default message of an assertion failure.

Annotations

@Override

overridingErrorMessage back to summary

overridingErrorMessage	back to summary
public void overridingErrorMessage(String newErrorMessage) Sets the message that will replace the default message of an assertion failure. Parameters newErrorMessage:String the new message. It can be `null`. Exceptions IllegalStateException: if the message has already been overridden with `overridingErrorMessage(Supplier)`.

public void overridingErrorMessage(String newErrorMessage)

Sets the message that will replace the default message of an assertion failure.

Parameters

newErrorMessage:String: the new message. It can be null.

Exceptions

IllegalStateException:: if the message has already been overridden with overridingErrorMessage(Supplier).

overridingErrorMessage back to summary

overridingErrorMessage	back to summary
public void overridingErrorMessage(Supplier<String> supplier) Sets the lazy fail message that will replace the default message of an assertion failure by using a supplier. Parameters supplier:Supplier<String> the new message by a supplier. It can be `null`. Exceptions IllegalStateException: if the message has already been overridden with `overridingErrorMessage(String)`.

public void overridingErrorMessage(Supplier<String> supplier)

Sets the lazy fail message that will replace the default message of an assertion failure by using a supplier.

Parameters

supplier:Supplier<String>: the new message by a supplier. It can be null.

Exceptions

IllegalStateException:: if the message has already been overridden with overridingErrorMessage(String).

representation	back to summary
public Representation representation() Implements org.assertj.core.api.AssertionInfo.representation. Annotations @Override

representation

back to summary

public Representation representation()

Implements org.assertj.core.api.AssertionInfo.representation.

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

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

useBinaryRepresentation	back to summary
public void useBinaryRepresentation()

useHexadecimalRepresentation	back to summary
public void useHexadecimalRepresentation()

useRepresentation	back to summary
public void useRepresentation(Representation newRepresentation)

useUnicodeRepresentation	back to summary
public void useUnicodeRepresentation()

public Class WritableAssertionInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail