Package org.fest.assertions.core

Class WritableAssertionInfo

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Description description()
      Returns the description of an assertion.
      void description​(java.lang.String newDescription)
      Sets the description of an assertion.
      void description​(Description newDescription)
      Sets the description of an assertion.
      java.lang.String descriptionText()
      Returns the text of this object's description, or null if such description is null.
      java.lang.String overridingErrorMessage()
      Returns the message that, if specified, will replace the default message of an assertion failure.
      void overridingErrorMessage​(java.lang.String newErrorMessage)
      Sets the message that will replace the default message of an assertion failure.
      java.lang.String toString()

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • WritableAssertionInfo

        public WritableAssertionInfo()

    • Method Detail

      • overridingErrorMessage

        public java.lang.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​(java.lang.String newErrorMessage)
        Sets the message that will replace the default message of an assertion failure.
        Parameters:
        newErrorMessage - the new message. It can be null.

      • description

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

      • descriptionText

        public java.lang.String descriptionText()
        Returns the text of this object's description, or null if such description is null.
        Returns:
        the text of this object's description, or null if such description is null.

      • description

        public void description​(java.lang.String newDescription)
        Sets the description of an assertion.
        Parameters:
        newDescription - the new description.
        Throws:
        java.lang.NullPointerException - if the given description is null.
        See Also:
        description(Description)

      • description

        public void description​(Description newDescription)
        Sets the description of an assertion. To remove or clear the description, pass a EmptyTextDescription as argument.
        Parameters:
        newDescription - the new description.
        Throws:
        java.lang.NullPointerException - if the given description is null.

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object