Class CharArrays


  • public class CharArrays
    extends java.lang.Object
    Reusable assertions for arrays of chars.
    Author:
    Alex Ruiz, Joel Costigliola, Mikhail Mazursky, Nicolas François
    • Method Detail

      • instance

        public static CharArrays instance()
        Returns the singleton instance of this class.
        Returns:
        the singleton instance of this class.
      • getComparator

        public java.util.Comparator<?> getComparator()
      • assertNullOrEmpty

        public void assertNullOrEmpty​(AssertionInfo info,
                                      char[] actual)
        Asserts that the given array is null or empty.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        Throws:
        java.lang.AssertionError - if the given array is not null *and* contains one or more elements.
      • assertEmpty

        public void assertEmpty​(AssertionInfo info,
                                char[] actual)
        Asserts that the given array is empty.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        Throws:
        java.lang.AssertionError - if the given array is null.
        java.lang.AssertionError - if the given array is not empty.
      • assertNotEmpty

        public void assertNotEmpty​(AssertionInfo info,
                                   char[] actual)
        Asserts that the given array is not empty.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        Throws:
        java.lang.AssertionError - if the given array is null.
        java.lang.AssertionError - if the given array is empty.
      • assertHasSize

        public void assertHasSize​(AssertionInfo info,
                                  char[] actual,
                                  int expectedSize)
        Asserts that the number of elements in the given array is equal to the expected one.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        expectedSize - the expected size of actual.
        Throws:
        java.lang.AssertionError - if the given array is null.
        java.lang.AssertionError - if the number of elements in the given array is different than the expected one.
      • assertHasSameSizeAs

        public void assertHasSameSizeAs​(AssertionInfo info,
                                        char[] actual,
                                        java.lang.Iterable<?> other)
        Assert that the actual array has the same size as the other Iterable.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        other - the group to compare
        Throws:
        java.lang.AssertionError - if the actual group is null.
        java.lang.AssertionError - if the other group is null.
        java.lang.AssertionError - if the actual group does not have the same size.
      • assertHasSameSizeAs

        public void assertHasSameSizeAs​(AssertionInfo info,
                                        char[] actual,
                                        java.lang.Object[] other)
        Assert that the actual array has the same size as the other array.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        other - the group to compare
        Throws:
        java.lang.AssertionError - if the actual group is null.
        java.lang.AssertionError - if the other group is null.
        java.lang.AssertionError - if the actual group does not have the same size.
      • assertContains

        public void assertContains​(AssertionInfo info,
                                   char[] actual,
                                   char[] values)
        Asserts that the given array contains the given values, in any order.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        values - the values that are expected to be in the given array.
        Throws:
        java.lang.NullPointerException - if the array of values is null.
        java.lang.IllegalArgumentException - if the array of values is empty.
        java.lang.AssertionError - if the given array is null.
        java.lang.AssertionError - if the given array does not contain the given values.
      • assertContains

        public void assertContains​(AssertionInfo info,
                                   char[] actual,
                                   char value,
                                   Index index)
        Verifies that the given array contains the given value at the given index.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        value - the value to look for.
        index - the index where the value should be stored in the given array.
        Throws:
        java.lang.AssertionError - if the given array is null or empty.
        java.lang.NullPointerException - if the given Index is null.
        java.lang.IndexOutOfBoundsException - if the value of the given Index is equal to or greater than the size of the given array.
        java.lang.AssertionError - if the given array does not contain the given value at the given index.
      • assertDoesNotContain

        public void assertDoesNotContain​(AssertionInfo info,
                                         char[] actual,
                                         char value,
                                         Index index)
        Verifies that the given array does not contain the given value at the given index.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        value - the value to look for.
        index - the index where the value should be stored in the given array.
        Throws:
        java.lang.AssertionError - if the given array is null.
        java.lang.NullPointerException - if the given Index is null.
        java.lang.AssertionError - if the given array contains the given value at the given index.
      • assertContainsOnly

        public void assertContainsOnly​(AssertionInfo info,
                                       char[] actual,
                                       char[] values)
        Asserts that the given array contains only the given values and nothing else, in any order.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        values - the values that are expected to be in the given array.
        Throws:
        java.lang.NullPointerException - if the array of values is null.
        java.lang.IllegalArgumentException - if the array of values is empty.
        java.lang.AssertionError - if the given array is null.
        java.lang.AssertionError - if the given array does not contain the given values or if the given array contains values that are not in the given array.
      • assertContainsSequence

        public void assertContainsSequence​(AssertionInfo info,
                                           char[] actual,
                                           char[] sequence)
        Verifies that the given array contains the given sequence of values, without any other values between them.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        sequence - the sequence of values to look for.
        Throws:
        java.lang.AssertionError - if the given array is null.
        java.lang.NullPointerException - if the given sequence is null.
        java.lang.IllegalArgumentException - if the given sequence is empty.
        java.lang.AssertionError - if the given array does not contain the given sequence of values.
      • assertDoesNotContain

        public void assertDoesNotContain​(AssertionInfo info,
                                         char[] actual,
                                         char[] values)
        Asserts that the given array does not contain the given values.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        values - the values that are expected not to be in the given array.
        Throws:
        java.lang.NullPointerException - if the array of values is null.
        java.lang.IllegalArgumentException - if the array of values is empty.
        java.lang.AssertionError - if the given array is null.
        java.lang.AssertionError - if the given array contains any of given values.
      • assertDoesNotHaveDuplicates

        public void assertDoesNotHaveDuplicates​(AssertionInfo info,
                                                char[] actual)
        Asserts that the given array does not have duplicate values.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        Throws:
        java.lang.NullPointerException - if the array of values is null.
        java.lang.IllegalArgumentException - if the array of values is empty.
        java.lang.AssertionError - if the given array is null.
        java.lang.AssertionError - if the given array contains duplicate values.
      • assertStartsWith

        public void assertStartsWith​(AssertionInfo info,
                                     char[] actual,
                                     char[] sequence)
        Verifies that the given array starts with the given sequence of values, without any other values between them. Similar to assertContainsSequence(AssertionInfo, char[], char[]), but it also verifies that the first element in the sequence is also the first element of the given array.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        sequence - the sequence of values to look for.
        Throws:
        java.lang.NullPointerException - if the given argument is null.
        java.lang.IllegalArgumentException - if the given argument is an empty array.
        java.lang.AssertionError - if the given array is null.
        java.lang.AssertionError - if the given array does not start with the given sequence of values.
      • assertEndsWith

        public void assertEndsWith​(AssertionInfo info,
                                   char[] actual,
                                   char[] sequence)
        Verifies that the given array ends with the given sequence of values, without any other values between them. Similar to assertContainsSequence(AssertionInfo, char[], char[]), but it also verifies that the last element in the sequence is also the last element of the given array.
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        sequence - the sequence of values to look for.
        Throws:
        java.lang.NullPointerException - if the given argument is null.
        java.lang.IllegalArgumentException - if the given argument is an empty array.
        java.lang.AssertionError - if the given array is null.
        java.lang.AssertionError - if the given array does not end with the given sequence of values.
      • assertIsSorted

        public void assertIsSorted​(AssertionInfo info,
                                   char[] actual)
        Concrete implementation of ArraySortedAssert.isSorted().
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
      • assertIsSortedAccordingToComparator

        public void assertIsSortedAccordingToComparator​(AssertionInfo info,
                                                        char[] actual,
                                                        java.util.Comparator<? super java.lang.Character> comparator)
        Parameters:
        info - contains information about the assertion.
        actual - the given array.
        comparator - the Comparator used to compare array elements