Package org.assertj.core.api

Class WritableAssertionInfo

java.lang.Object
org.assertj.core.api.WritableAssertionInfo
All Implemented Interfaces:
AssertionInfo
public class WritableAssertionInfo extends Object implements AssertionInfo
Writable information about an assertion.
Author:
Alex Ruiz, Yvonne Wang

  • Constructor Details

    • WritableAssertionInfo

      public WritableAssertionInfo(Representation customRepresentation)

    • WritableAssertionInfo

      public WritableAssertionInfo()

  • Method Details

    • overridingErrorMessage

      public String overridingErrorMessage()
      Returns the message that, if specified, will replace the default message of an assertion failure.
      Specified by:
      overridingErrorMessage in interface AssertionInfo
      Returns:
      the message that, if specified, will replace the default message of an assertion failure.

    • overridingErrorMessage

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

    • overridingErrorMessage

      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 - the new message by a supplier. It can be null.
      Throws:
      IllegalStateException - if the message has already been overridden with overridingErrorMessage(String).

    • description

      public Description description()
      Returns the description of an assertion.
      Specified by:
      description in interface AssertionInfo
      Returns:
      the description of an assertion.

    • descriptionText

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

    • hasDescription

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

    • description

      public void description(String newDescription, Object... args)
      Sets the description of an assertion, if given null an empty Description is set.
      Parameters:
      newDescription - the new description.
      args - if newDescription is a format String, args is argument of String.format(String, Object...)
      See Also:

    • 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 - the new description.

    • representation

      public Representation representation()
      Specified by:
      representation in interface AssertionInfo

    • useHexadecimalRepresentation

      public void useHexadecimalRepresentation()

    • useUnicodeRepresentation

      public void useUnicodeRepresentation()

    • useBinaryRepresentation

      public void useBinaryRepresentation()

    • useRepresentation

      public void useRepresentation(Representation newRepresentation)

    • mostRelevantDescriptionIn

      public static String mostRelevantDescriptionIn(WritableAssertionInfo info, String newDescription)

    • toString

      public String toString()
      Overrides:
      toString in class Object