com.fitbur.assertj.api.AbstractByteAssert 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.Offset;
import com.fitbur.assertj.data.Percentage;
import com.fitbur.assertj.internal.Bytes;
import com.fitbur.assertj.internal.ComparatorBasedComparisonStrategy;
import com.fitbur.assertj.util.VisibleForTesting;
/**
* Base class for all implementations of assertions for {@link Byte}s.
*
* @param the "self" type of this assertion class. Please read "Emulating 'self types' using Java Generics to simplify fluent API implementation"
* for more details.
*
* @author Yvonne Wang
* @author David DIDIER
* @author Ansgar Konermann
* @author Alex Ruiz
* @author Mikhail Mazursky
* @author Nicolas François
*/
public abstract class AbstractByteAssert> extends AbstractComparableAssert
implements NumberAssert {
@VisibleForTesting
Bytes bytes = Bytes.instance();
protected AbstractByteAssert(Byte actual, Class selfType) {
super(actual, selfType);
}
/**
* Verifies that the actual value is equal to the given one.
*
* Example:
* // assertions will pass
* assertThat((byte) 1).isEqualTo((byte) 1);
* assertThat((byte) 0).isEqualTo(Byte.valueOf("0"));
*
* // assertions will fail
* assertThat((byte) 1).isEqualTo((byte) 0);
* assertThat(Byte.valueOf("1")).isEqualTo((byte) 0);
*
* @param expected the given value to compare the actual value to.
* @return {@code this} assertion object.
* @throws AssertionError if the actual value is {@code null}.
* @throws AssertionError if the actual value is not equal to the given one.
*/
public S isEqualTo(byte expected) {
bytes.assertEqual(info, actual, expected);
return myself;
}
/**
* Verifies that the actual value is not equal to the given one.
*
* Example:
* // assertions will pass
* assertThat((byte) 0).isNotEqualTo((byte) 1);
* assertThat(Byte.valueOf("1")).isNotEqualTo((byte) 0);
*
* // assertions will fail
* assertThat((byte) 0).isNotEqualTo((byte) 0);
* assertThat(Byte.valueOf("0")).isNotEqualTo((byte) 0);
*
* @param other the given value to compare the actual value to.
* @return {@code this} assertion object.
* @throws AssertionError if the actual value is {@code null}.
* @throws AssertionError if the actual value is equal to the given one.
*/
public S isNotEqualTo(byte other) {
bytes.assertNotEqual(info, actual, other);
return myself;
}
/** {@inheritDoc} */
@Override
public S isZero() {
bytes.assertIsZero(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S isNotZero() {
bytes.assertIsNotZero(info, actual);
return myself;
}
/**
* {@inheritDoc}
*
* Example:
*
// assertion will pass
* assertThat((byte) 1).isPositive();
*
* // assertion will fail
* assertThat((byte) -1).isPositive();
*
*
*/
@Override
public S isPositive() {
bytes.assertIsPositive(info, actual);
return myself;
}
/**
* {@inheritDoc}
*
* Example:
*
// assertion will pass
* assertThat((byte) -1).isNegative();
*
* // assertion will fail
* assertThat((byte) 1).isNegative();
*
*
*/
@Override
public S isNegative() {
bytes.assertIsNegative(info, actual);
return myself;
}
/**
* {@inheritDoc}
*
* Example:
*
// assertion will pass
* assertThat((byte) 1).isNotNegative();
*
* // assertion will fail
* assertThat((byte) -1).isNotNegative();
*
*
*/
@Override
public S isNotNegative() {
bytes.assertIsNotNegative(info, actual);
return myself;
}
/**
* {@inheritDoc}
*
* Example:
*
// assertion will pass
* assertThat((byte) -1).isNotPositive();
*
* // assertion will fail
* assertThat((byte) 1).isNotPositive();
*
*
*/
@Override
public S isNotPositive() {
bytes.assertIsNotPositive(info, actual);
return myself;
}
/**
* Verifies that the actual value is less than the given one.
*
* Example:
*
// assertion will pass
* assertThat((byte) 1).isLessThan((byte) 2);
*
* // assertion will fail
* assertThat((byte) 1).isLessThan((byte) 0);
* assertThat((byte) 1).isLessThan((byte) 1);
*
*
*
* @param other the given value to compare the actual value to.
* @return {@code this} assertion object.
* @throws AssertionError if the actual value is {@code null}.
* @throws AssertionError if the actual value is equal to or greater than the given one.
*/
public S isLessThan(byte other) {
bytes.assertLessThan(info, actual, other);
return myself;
}
/**
* Verifies that the actual value is less than or equal to the given one.
*
* Example:
*
// assertion will pass
* assertThat((byte) 1).isLessThanOrEqualTo((byte) 2);
* assertThat((byte) 1).isLessThanOrEqualTo((byte) 1);
*
* // assertion will fail
* assertThat((byte) 1).isLessThanOrEqualTo((byte) 0);
*
*
*
* @param other the given value to compare the actual value to.
* @return {@code this} assertion object.
* @throws AssertionError if the actual value is {@code null}.
* @throws AssertionError if the actual value is greater than the given one.
*/
public S isLessThanOrEqualTo(byte other) {
bytes.assertLessThanOrEqualTo(info, actual, other);
return myself;
}
/**
* Verifies that the actual value is greater than the given one.
*
* Example:
*
// assertion will pass
* assertThat((byte) 2).isGreaterThan((byte) 1);
*
* // assertion will fail
* assertThat((byte) 2).isGreaterThan((byte) 3);
* assertThat((byte) 2).isGreaterThan((byte) 2);
*
*
*
* @param other the given value to compare the actual value to.
* @return {@code this} assertion object.
* @throws AssertionError if the actual value is {@code null}.
* @throws AssertionError if the actual value is equal to or less than the given one.
*/
public S isGreaterThan(byte other) {
bytes.assertGreaterThan(info, actual, other);
return myself;
}
/**
* Verifies that the actual value is greater than or equal to the given one.
*
* Example:
*
// assertion will pass
* assertThat((byte) 2).isGreaterThanOrEqualTo((byte) 1);
* assertThat((byte) 2).isGreaterThanOrEqualTo((byte) 2);
*
* // assertion will fail
* assertThat((byte) 2).isGreaterThanOrEqualTo((byte) 3);
*
*
*
* @param other the given value to compare the actual value to.
* @return {@code this} assertion object.
* @throws AssertionError if the actual value is {@code null}.
* @throws AssertionError if the actual value is less than the given one.
*/
public S isGreaterThanOrEqualTo(byte other) {
bytes.assertGreaterThanOrEqualTo(info, actual, other);
return myself;
}
/**
* Verifies that the actual value is in [start, end] range (start included, end included).
*
*
* Example:
*
// assertions will pass
* assertThat((byte) 1).isBetween((byte) -1, (byte) 2);
* assertThat((byte) 1).isBetween((byte) 1, (byte) 2);
* assertThat((byte) 1).isBetween((byte) 0, (byte) 1);
*
* // assertion will fail
* assertThat((byte) 1).isBetween((byte) 2, (byte) 3);
*
*
*/
@Override
public S isBetween(Byte start, Byte end) {
bytes.assertIsBetween(info, actual, start, end);
return myself;
}
/**
* Verifies that the actual value is in ]start, end[ range (start excluded, end excluded).
*
*
* Example:
*
// assertion will pass
* assertThat((byte) 1).isStrictlyBetween((byte) -1, (byte) 2);
*
* // assertions will fail
* assertThat((byte) 1).isStrictlyBetween((byte) 1, (byte) 2);
* assertThat((byte) 1).isStrictlyBetween((byte) 0, (byte) 1);
* assertThat((byte) 1).isStrictlyBetween((byte) 2, (byte) 3);
*
*
*/
@Override
public S isStrictlyBetween(Byte start, Byte end) {
bytes.assertIsStrictlyBetween(info, actual, start, end);
return myself;
}
/**
* Verifies that the actual byte is close to the given one within the given offset.
* If difference is equal to offset value, assertion is considered valid.
*
* Example :
*
// assertions will pass:
* assertThat((byte) 5).isCloseTo((byte) 7, within((byte) 3));
*
* // if difference is exactly equals to the offset, it's ok
* assertThat((byte) 5).isCloseTo((byte) 7, within((byte) 2));
*
* // assertion will fail
* assertThat((byte) 5).isCloseTo((byte) 7, within((byte) 1));
*
* @param expected the given byte to compare the actual value to.
* @param offset the given positive offset.
* @return {@code this} assertion object.
* @throws NullPointerException if the given offset is {@code null}.
* @throws AssertionError if the actual value is not equal to the given one.
*/
public S isCloseTo(byte expected, Offset offset) {
bytes.assertIsCloseTo(info, actual, expected, offset);
return myself;
}
/**
* Verifies that the actual Byte is close to the given one within the given offset.
* If difference is equal to offset value, assertion is considered valid.
*
* Example :
*
// assertions will pass:
* assertThat((byte) 5).isCloseTo(new Byte("7"), within((byte) 3));
*
* // if difference is exactly equals to the offset, it's ok
* assertThat((byte) 5).isCloseTo(new Byte("7"), within((byte) 2));
*
* // assertion will fail
* assertThat((byte) 5).isCloseTo(new Byte("7"), within((byte) 1));
*
* @param expected the given Byte to compare the actual value to.
* @param offset the given positive offset.
* @return {@code this} assertion object.
* @throws NullPointerException if the given offset is {@code null}.
* @throws NullPointerException if the expected Byte is {@code null}.
* @throws AssertionError if the actual value is not equal to the given one.
*/
@Override
public S isCloseTo(Byte expected, Offset offset) {
bytes.assertIsCloseTo(info, actual, expected, offset);
return myself;
}
/**
* Verifies that the actual number is close to the given one within the given percentage.
* If difference is equal to the percentage value, assertion is considered valid.
*
* Example with byte:
*
// assertions will pass:
* assertThat((byte) 11).isCloseTo(Byte.valueOf(10), withinPercentage((byte) 20));
*
* // if difference is exactly equals to the computed offset (1), it's ok
* assertThat((byte) 11).isCloseTo(Byte.valueOf(10), withinPercentage((byte) 10));
*
* // assertion will fail
* assertThat((byte) 11).isCloseTo(Byte.valueOf(10), withinPercentage((byte) 5));
*
* @param expected the given number to compare the actual value to.
* @param percentage the given positive percentage.
* @return {@code this} assertion object.
* @throws NullPointerException if the given offset is {@code null}.
* @throws NullPointerException if the expected number is {@code null}.
* @throws AssertionError if the actual value is not equal to the given one.
*/
@Override
public S isCloseTo(Byte expected, Percentage percentage) {
bytes.assertIsCloseToPercentage(info, actual, expected, percentage);
return myself;
}
/**
* Verifies that the actual number is close to the given one within the given percentage.
* If difference is equal to the percentage value, assertion is considered valid.
*
* Example with byte:
*
// assertions will pass:
* assertThat((byte) 11).isCloseTo((byte) 10, withinPercentage((byte) 20));
*
* // if difference is exactly equals to the computed offset (1), it's ok
* assertThat((byte) 11).isCloseTo((byte) 10, withinPercentage((byte) 10));
*
* // assertion will fail
* assertThat((byte) 11).isCloseTo((byte) 10, withinPercentage((byte) 5));
*
* @param expected the given number to compare the actual value to.
* @param percentage the given positive percentage.
* @return {@code this} assertion object.
* @throws NullPointerException if the given offset is {@code null}.
* @throws NullPointerException if the expected number is {@code null}.
* @throws AssertionError if the actual value is not equal to the given one.
*/
public S isCloseTo(byte expected, Percentage percentage) {
bytes.assertIsCloseToPercentage(info, actual, expected, percentage);
return myself;
}
@Override
public S usingComparator(Comparator customComparator) {
super.usingComparator(customComparator);
this.bytes = new Bytes(new ComparatorBasedComparisonStrategy(customComparator));
return myself;
}
@Override
public S usingDefaultComparator() {
super.usingDefaultComparator();
this.bytes = Bytes.instance();
return myself;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy