com.fitbur.assertj.api.AbstractCharArrayAssert Maven / Gradle / Ivy
/**
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*
* Copyright 2012-2016 the original author or authors.
*/
package com.fitbur.assertj.api;
import java.util.Comparator;
import com.fitbur.assertj.data.Index;
import com.fitbur.assertj.internal.CharArrays;
import com.fitbur.assertj.internal.ComparatorBasedComparisonStrategy;
import com.fitbur.assertj.util.VisibleForTesting;
public abstract class AbstractCharArrayAssert>
extends AbstractArrayAssert {
@VisibleForTesting
protected CharArrays arrays = CharArrays.instance();
public AbstractCharArrayAssert(char[] actual, Class selfType) {
super(actual, selfType);
}
/** {@inheritDoc} */
@Override
public void isNullOrEmpty() {
arrays.assertNullOrEmpty(info, actual);
}
/** {@inheritDoc} */
@Override
public void isEmpty() {
arrays.assertEmpty(info, actual);
}
/** {@inheritDoc} */
@Override
public S isNotEmpty() {
arrays.assertNotEmpty(info, actual);
return myself;
}
/**
* {@inheritDoc}
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).hasSize(3);
*
* // assertion will fail
* assertThat(new char[] { 'a', 'b', 'c', 'd' }).hasSize(3);
*
*
*
*/
@Override
public S hasSize(int expected) {
arrays.assertHasSize(info, actual, expected);
return myself;
}
/**
* Verifies that the actual group has the same size as given {@link Iterable}.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b' }).hasSameSizeAs(Arrays.asList(1, 2));
*
* // assertion will fail
* assertThat(new char[] { 'a', 'b' }).hasSameSizeAs(Arrays.asList(1, 2, 3));
*
*
*/
@Override
public S hasSameSizeAs(Iterable other) {
arrays.assertHasSameSizeAs(info, actual, other);
return myself;
}
/**
* Verifies that the actual array contains the given values, in any order.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).contains('a', 'b');
* assertThat(new char[] { 'a', 'b', 'c' }).contains('c', 'a');
* assertThat(new char[] { 'a', 'b', 'c' }).contains('a', 'c', 'b');
*
* // assertion will fail
* assertThat(new char[] { 'a', 'b', 'c' }).contains('a', 'd');
* assertThat(new char[] { 'a', 'b', 'c' }).contains('d', 'f');
*
*
*
* @param values the given values.
* @return {@code this} assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array does not contain the given values.
*/
public S contains(char... values) {
arrays.assertContains(info, actual, values);
return myself;
}
/**
* Verifies that the actual array contains only the given values and nothing else, in any order.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).containsOnly('a', 'b', 'c');
* assertThat(new char[] { 'a', 'b', 'c' }).containsOnly('b', 'c', 'a');
*
* // assertion will fail
* * assertThat(new char[] { 'a', 'b', 'c' }).containsOnly('a', 'b', 'c', 'd');
* * assertThat(new char[] { 'a', 'b', 'c' }).containsOnly('d', 'f');
*
*
*
* @param values the given values.
* @return {@code this} assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array does not contain the given values, i.e. the actual array contains some
* or none of the given values, or the actual array contains more values than the given ones.
*/
public S containsOnly(char... values) {
arrays.assertContainsOnly(info, actual, values);
return myself;
}
/**
* Verifies that the actual array contains the given values only once.
*
* Examples :
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).containsOnlyOnce('a', 'b');
*
* // assertions will fail
* assertThat(new char[] { 'a', 'b', 'a' }).containsOnlyOnce('a');
* assertThat(new char[] { 'a', 'b', 'c' }).containsOnlyOnce('d');
* assertThat(new char[] { 'a', 'b', 'c', 'c' }).containsOnlyOnce('0', 'a', 'b', 'c', 'd', 'e');
*
* @param values the given values.
* @return {@code this} assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual group does not contain the given values, i.e. the actual group contains some
* or none of the given values, or the actual group contains more than once these values.
*/
public S containsOnlyOnce(char... values) {
arrays.assertContainsOnlyOnce(info, actual, values);
return myself;
}
/**
* Verifies that the actual array contains the given sequence, without any other values between them.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).containsSequence('a', 'b');
* assertThat(new char[] { 'a', 'b', 'c' }).containsSequence('a', 'b', 'c');
* assertThat(new char[] { 'a', 'b', 'c' }).containsSequence('b', 'c');
*
* // assertion will fail
* assertThat(new char[] { 'a', 'b', 'c' }).containsSequence('c', 'a');
* assertThat(new char[] { 'a', 'b', 'c' }).containsSequence('d', 'f');
*
*
*
* @param sequence the sequence of values to look for.
* @return myself assertion object.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the actual array does not contain the given sequence.
*/
public S containsSequence(char... sequence) {
arrays.assertContainsSequence(info, actual, sequence);
return myself;
}
/**
* Verifies that the actual array contains the given subsequence (possibly with other values between them).
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).containsSubsequence('a', 'b');
* assertThat(new char[] { 'a', 'b', 'c' }).containsSubsequence('a', 'c');
* assertThat(new char[] { 'a', 'b', 'c' }).containsSubsequence('b', 'c');
* assertThat(new char[] { 'a', 'b', 'c' }).containsSubsequence('a', 'b', 'c');
*
* // assertion will fail
* assertThat(new char[] { 'a', 'b', 'c' }).containsSubsequence('c', 'a');
* assertThat(new char[] { 'a', 'b', 'c' }).containsSubsequence('d', 'f');
*
*
*
* @param subsequence the subsequence of values to look for.
* @return myself assertion object.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the given array is {@code null}.
* @throws AssertionError if the actual array does not contain the given subsequence.
*/
public S containsSubsequence(char... subsequence) {
arrays.assertContainsSubsequence(info, actual, subsequence);
return myself;
}
/**
* Verifies that the actual array contains the given value at the given index.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).contains('a', atIndex(O));
* assertThat(new char[] { 'a', 'b', 'c' }).contains('c', atIndex(2));
*
* // assertion will fail
* assertThat(new char[] { 'a', 'b', 'c' }).contains('a', atIndex(1));
* assertThat(new char[] { 'a', 'b', 'c' }).contains('d', atIndex(2));
*
*
*
* @param value the value to look for.
* @param index the index where the value should be stored in the actual array.
* @return myself assertion object.
* @throws AssertionError if the actual array is {@code null} or empty.
* @throws NullPointerException if the given {@code Index} is {@code null}.
* @throws IndexOutOfBoundsException if the value of the given {@code Index} is equal to or greater than the size of
* the actual array.
* @throws AssertionError if the actual array does not contain the given value at the given index.
*/
public S contains(char value, Index index) {
arrays.assertContains(info, actual, value, index);
return myself;
}
/**
* Verifies that the actual array does not contain the given values.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).doesNotContain('d');
*
* // assertion will fail
* assertThat(new char[] { 'a', 'b', 'c' }).doesNotContain('b');
*
*
*
* @param values the given values.
* @return {@code this} assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array contains any of the given values.
*/
public S doesNotContain(char... values) {
arrays.assertDoesNotContain(info, actual, values);
return myself;
}
/**
* Verifies that the actual array does not contain the given value at the given index.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).doesNotContain('a', atIndex(1));
* assertThat(new char[] { 'a', 'b', 'c' }).doesNotContain('b', atIndex(0));
*
* // assertion will fail
* * assertThat(new char[] { 'a', 'b', 'c' }).doesNotContain('a', atIndex(0));
* * assertThat(new char[] { 'a', 'b', 'c' }).doesNotContain('b', atIndex(1));
*
*
*
* @param value the value to look for.
* @param index the index where the value should be stored in the actual array.
* @return myself assertion object.
* @throws AssertionError if the actual array is {@code null}.
* @throws NullPointerException if the given {@code Index} is {@code null}.
* @throws AssertionError if the actual array contains the given value at the given index.
*/
public S doesNotContain(char value, Index index) {
arrays.assertDoesNotContain(info, actual, value, index);
return myself;
}
/**
* Verifies that the actual array does not contain duplicates.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).doesNotHaveDuplicates();
*
* // assertion will fail
* assertThat(new char[] { 'a', 'a', 'b', 'c' }).doesNotHaveDuplicates();
*
*
*
* @return {@code this} assertion object.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array contains duplicates.
*/
public S doesNotHaveDuplicates() {
arrays.assertDoesNotHaveDuplicates(info, actual);
return myself;
}
/**
* Verifies that the actual array starts with the given sequence of values, without any other values between them.
* Similar to {@link #containsSequence(char...)}, but it also verifies that the first element in the
* sequence is also first element of the actual array.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).startsWith('a', 'b');
*
* // assertion will fail
* assertThat(new char[] { 'a', 'b', 'c' }).startsWith('b', 'c');
*
*
*
* @param sequence the sequence of values to look for.
* @return myself assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array does not start with the given sequence.
*/
public S startsWith(char... sequence) {
arrays.assertStartsWith(info, actual, sequence);
return myself;
}
/**
* Verifies that the actual array ends with the given sequence of values, without any other values between them.
* Similar to {@link #containsSequence(char...)}, but it also verifies that the last element in the
* sequence is also last element of the actual array.
*
* Example:
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).endsWith('b', 'c');
*
* // assertion will fail
* assertThat(new char[] { 'a', 'b', 'c' }).endsWith('c', 'd');
*
*
*
* @param sequence the sequence of values to look for.
* @return myself assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws IllegalArgumentException if the given argument is an empty array.
* @throws AssertionError if the actual array is {@code null}.
* @throws AssertionError if the actual array does not end with the given sequence.
*/
public S endsWith(char... sequence) {
arrays.assertEndsWith(info, actual, sequence);
return myself;
}
/** {@inheritDoc} */
@Override
public S isSorted() {
arrays.assertIsSorted(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S isSortedAccordingTo(Comparator comparator) {
arrays.assertIsSortedAccordingToComparator(info, actual, comparator);
return myself;
}
/** {@inheritDoc} */
@Override
public S usingElementComparator(Comparator customComparator) {
this.arrays = new CharArrays(new ComparatorBasedComparisonStrategy(customComparator));
return myself;
}
/** {@inheritDoc} */
@Override
public S usingDefaultElementComparator() {
this.arrays = CharArrays.instance();
return myself;
}
/**
* Verifies that the actual group contains only the given values and nothing else, in order.
*
* Example :
*
// assertion will pass
* assertThat(new char[] { 'a', 'b', 'c' }).containsExactly('a', 'b', 'c');
*
* // assertion will fail as actual and expected order differ
* assertThat(new char[] { 'a', 'b', 'c' }).containsExactly('b', 'a', 'c');
*
* @param values the given values.
* @return {@code this} assertion object.
* @throws NullPointerException if the given argument is {@code null}.
* @throws AssertionError if the actual group is {@code null}.
* @throws AssertionError if the actual group does not contain the given values with same order, i.e. the actual group
* contains some or none of the given values, or the actual group contains more values than the given ones
* or values are the same but the order is not.
*/
public S containsExactly(char... values) {
objects.assertEqual(info, actual, values);
return myself;
}
/**
* Use unicode character representation instead of standard representation in error messages.
*
* With standard error message:
* assertThat("a6c".toCharArray()).isEqualTo("abó".toCharArray());
*
* org.junit.ComparisonFailure:
* Expected :['a', 'b', 'ó']
* Actual :[a, 6, c]
*
* With unicode based error message:
* assertThat("a6c".toCharArray()).inUnicode().isEqualTo("abó".toCharArray());
*
* org.junit.ComparisonFailure:
* Expected :[a, b, \u00f3]
* Actual :[a, 6, c]
*
* @return {@code this} assertion object.
*/
public S inUnicode() {
info.useUnicodeRepresentation();
return myself;
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy