com.fitbur.assertj.api.AbstractByteArrayAssert Maven / Gradle / Ivy
The newest version!
/**
* 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.ByteArrays;
import com.fitbur.assertj.internal.ComparatorBasedComparisonStrategy;
import com.fitbur.assertj.util.VisibleForTesting;
public abstract class AbstractByteArrayAssert>
extends AbstractArrayAssert {
@VisibleForTesting
protected ByteArrays arrays = ByteArrays.instance();
public AbstractByteArrayAssert(byte[] 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 byte[] { 1, 2, 3 }).hasSize(3);
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3, 4 }).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}.
*
* Examples:
* // assertion will pass
* assertThat(new byte[] { 1, 2 }).hasSameSizeAs(Arrays.asList(2, 3));
*
* // assertion will fail
* assertThat(new byte[] { 1, 2 }).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 byte[] { 1, 2, 3 }).contains((byte) 1, (byte) 2);
* assertThat(new byte[] { 1, 2, 3 }).contains((byte) 3, (byte) 1);
* assertThat(new byte[] { 1, 2, 3 }).contains((byte) 1, (byte) 3, (byte) 2);
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3 }).contains((byte) 1, (byte) 4);
* assertThat(new byte[] { 1, 2, 3 }).contains((byte) 4, (byte) 7);
*
*
*
* @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(byte... 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 byte[] { 1, 2, 3 }).containsOnly((byte) 1, (byte) 2, (byte) 3);
* assertThat(new byte[] { 1, 2, 3 }).containsOnly((byte) 2, (byte) 3, (byte) 1);
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3 }).containsOnly((byte) 1, (byte) 2, (byte) 3, (byte) 4);
* assertThat(new byte[] { 1, 2, 3 }).containsOnly((byte) 4, (byte) 7);
*
*
*
* @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(byte... 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 byte[] { 1, 2, 3 }).containsOnlyOnce((byte) 1, (byte) 2);
*
* // assertions will fail
* assertThat(new byte[] { 1, 2, 1 }).containsOnlyOnce((byte) 1);
* assertThat(new byte[] { 1, 2, 3 }).containsOnlyOnce((byte) 4);
* assertThat(new byte[] { 1, 2, 3, 3 }).containsOnlyOnce((byte) 0, (byte) 1, (byte) 2, (byte) 3, (byte) 4, (byte) 5);
*
* @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(byte... 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 byte[] { 1, 2, 3 }).containsSequence((byte) 1, (byte) 2);
* assertThat(new byte[] { 1, 2, 3 }).containsSequence((byte) 1, (byte) 2, (byte) 3);
* assertThat(new byte[] { 1, 2, 3 }).containsSequence((byte) 2, (byte) 3);
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3 }).containsSequence((byte) 1, (byte) 3);
* assertThat(new byte[] { 1, 2, 3 }).containsSequence((byte) 4, (byte) 7);
*
*
*
* @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(byte... 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 byte[] { 1, 2, 3 }).containsSubsequence((byte) 1, (byte) 2, (byte) 3);
* assertThat(new byte[] { 1, 2, 3 }).containsSubsequence((byte) 1, (byte) 2);
* assertThat(new byte[] { 1, 2, 3 }).containsSubsubsequence((byte) 1, (byte) 3);
* assertThat(new byte[] { 1, 2, 3 }).containsSubsequence((byte) 2, (byte) 3);
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3 }).containsSubsequence((byte) 2, (byte) 1);
* assertThat(new byte[] { 1, 2, 3 }).containsSubsequence((byte) 4, (byte) 7);
*
*
*
* @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(byte... 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 byte[] { 1, 2, 3 }).contains((byte) 1, atIndex(O));
* assertThat(new byte[] { 1, 2, 3 }).contains((byte) 3, atIndex(2));
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3 }).contains((byte) 1, atIndex(1));
* assertThat(new byte[] { 1, 2, 3 }).contains((byte) 4, 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(byte 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 byte[] { 1, 2, 3 }).doesNotContain((byte) 4);
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3 }).doesNotContain((byte) 2);
*
*
*
* @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(byte... 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 byte[] { 1, 2, 3 }).doesNotContain((byte) 1, atIndex(1));
* assertThat(new byte[] { 1, 2, 3 }).doesNotContain((byte) 2, atIndex(0));
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3 }).doesNotContain((byte) 1, atIndex(0));
* assertThat(new byte[] { 1, 2, 3 }).doesNotContain((byte) 2, 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(byte 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 byte[] { 1, 2, 3 }).doesNotHaveDuplicates();
*
* // assertion will fail
* assertThat(new byte[] { 1, 1, 2, 3 }).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(byte...)}, 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 byte[] { 1, 2, 3 }).startsWith((byte) 1, (byte) 2);
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3 }).startsWith((byte) 2, (byte) 3);
*
*
*
* @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(byte... 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(byte...)}, 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 byte[] { 1, 2, 3 }).endsWith((byte) 2, (byte) 3);
*
* // assertion will fail
* assertThat(new byte[] { 1, 2, 3 }).endsWith((byte) 3, (byte) 4);
*
*
*
* @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(byte... 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 ByteArrays(new ComparatorBasedComparisonStrategy(customComparator));
return myself;
}
/** {@inheritDoc} */
@Override
public S usingDefaultElementComparator() {
this.arrays = ByteArrays.instance();
return myself;
}
/**
* Verifies that the actual group contains only the given values and nothing else, in order.
*
* Example :
*
// assertion will pass
* assertThat(new byte[] { 1, 2, 3 }).containsExactly((byte) 1, (byte) 2, (byte) 3);
*
* // assertion will fail as actual and expected order differ
* assertThat(new byte[] { 1, 2, 3 }).containsExactly((byte) 2, (byte) 1, (byte) 3);
*
* @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(byte... values) {
objects.assertEqual(info, actual, values);
return myself;
}
}