Class Throwables


  • public class Throwables
    extends Object
    Reusable assertions for Throwables.
    Author:
    Joel Costigliola, Libor Ondrusek
    • Method Detail

      • instance

        public static Throwables instance()
        Returns the singleton instance of this class.
        Returns:
        the singleton instance of this class.
      • assertHasMessage

        public void assertHasMessage​(AssertionInfo info,
                                     Throwable actual,
                                     String message)
        Asserts that the given actual Throwable message is equal to the given one.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        message - the expected message.
        Throws:
        AssertionError - if the actual Throwable is null.
        AssertionError - if the message of the actual Throwable is not equal to the given one.
      • assertHasNoCause

        public void assertHasNoCause​(AssertionInfo info,
                                     Throwable actual)
        Asserts that the actual Throwable does not have a cause.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        Throws:
        AssertionError - if the actual Throwable is null.
        AssertionError - if the actual Throwable has a cause.
      • assertHasMessageStartingWith

        public void assertHasMessageStartingWith​(AssertionInfo info,
                                                 Throwable actual,
                                                 String description)
        Asserts that the message of the actual Throwable starts with the given description.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        description - the description expected to start the actual Throwable's message.
        Throws:
        AssertionError - if the actual Throwable is null.
        AssertionError - if the message of the actual Throwable does not start with the given description.
      • assertHasMessageContaining

        public void assertHasMessageContaining​(AssertionInfo info,
                                               Throwable actual,
                                               String description)
        Asserts that the message of the actual Throwable contains with the given description.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        description - the description expected to be contained in the actual Throwable's message.
        Throws:
        AssertionError - if the actual Throwable is null.
        AssertionError - if the message of the actual Throwable does not contain the given description.
      • assertHasStackTraceContaining

        public void assertHasStackTraceContaining​(AssertionInfo info,
                                                  Throwable actual,
                                                  String description)
        Asserts that the stack trace of the actual Throwable contains with the given description.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        description - the description expected to be contained in the actual Throwable's stack trace.
        Throws:
        AssertionError - if the actual Throwable is null.
        AssertionError - if the stack trace of the actual Throwable does not contain the given description.
      • assertHasMessageMatching

        public void assertHasMessageMatching​(AssertionInfo info,
                                             Throwable actual,
                                             String regex)
        Asserts that the message of the actual Throwable matches with the given regular expression.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        regex - the regular expression of value expected to be matched the actual Throwable's message.
        Throws:
        AssertionError - if the actual Throwable is null.
        AssertionError - if the message of the actual Throwable does not match the given regular expression.
        NullPointerException - if the regex is null
      • assertHasMessageEndingWith

        public void assertHasMessageEndingWith​(AssertionInfo info,
                                               Throwable actual,
                                               String description)
        Asserts that the message of the actual Throwable ends with the given description.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        description - the description expected to end the actual Throwable's message.
        Throws:
        AssertionError - if the actual Throwable is null.
        AssertionError - if the message of the actual Throwable does not end with the given description.
      • assertHasCauseInstanceOf

        public void assertHasCauseInstanceOf​(AssertionInfo info,
                                             Throwable actual,
                                             Class<? extends Throwable> type)
        Assert that the cause of actual Throwable is an instance of the given type.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        type - the expected cause type.
        Throws:
        NullPointerException - if given type is null.
        AssertionError - if the actual Throwable is null.
        AssertionError - if the actual Throwable has no cause.
        AssertionError - if the cause of the actual Throwable is not an instance of the given type.
      • assertHasCauseExactlyInstanceOf

        public void assertHasCauseExactlyInstanceOf​(AssertionInfo info,
                                                    Throwable actual,
                                                    Class<? extends Throwable> type)
        Assert that the cause of actual Throwable is exactly an instance of the given type.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        type - the expected cause type.
        Throws:
        NullPointerException - if given type is null.
        AssertionError - if the actual Throwable is null.
        AssertionError - if the actual Throwable has no cause.
        AssertionError - if the cause of the actual Throwable is not exactly an instance of the given type.
      • assertHasRootCauseInstanceOf

        public void assertHasRootCauseInstanceOf​(AssertionInfo info,
                                                 Throwable actual,
                                                 Class<? extends Throwable> type)
        Assert that the root cause of actual Throwable is an instance of the given type.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        type - the expected cause type.
        Throws:
        NullPointerException - if given type is null.
        AssertionError - if the actual Throwable is null.
        AssertionError - if the actual Throwable has no cause.
        AssertionError - if the cause of the actual Throwable is not an instance of the given type.
      • assertHasRootCauseExactlyInstanceOf

        public void assertHasRootCauseExactlyInstanceOf​(AssertionInfo info,
                                                        Throwable actual,
                                                        Class<? extends Throwable> type)
        Assert that the root cause of actual Throwable is exactly an instance of the given type.
        Parameters:
        info - contains information about the assertion.
        actual - the given Throwable.
        type - the expected cause type.
        Throws:
        NullPointerException - if given type is null.
        AssertionError - if the actual Throwable is null.
        AssertionError - if the actual Throwable has no cause.
        AssertionError - if the root cause of the actual Throwable is not exactly an instance of the given type.
      • assertHasNoSuppressedExceptions

        public void assertHasNoSuppressedExceptions​(AssertionInfo info,
                                                    Throwable actual)
      • assertHasSuppressedException

        public void assertHasSuppressedException​(AssertionInfo info,
                                                 Throwable actual,
                                                 Throwable expectedSuppressedException)