com.fitbur.assertj.api.AbstractLongAssert 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.ComparatorBasedComparisonStrategy;
import com.fitbur.assertj.internal.Longs;
import com.fitbur.assertj.util.VisibleForTesting;
/**
* Base class for all implementations of assertions for {@link Long}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 Joel Costigliola
* @author Mikhail Mazursky
* @author Nicolas François
*/
public abstract class AbstractLongAssert> extends AbstractComparableAssert
implements NumberAssert {
@VisibleForTesting
Longs longs = Longs.instance();
protected AbstractLongAssert(Long actual, Class selfType) {
super(actual, selfType);
}
/**
* Verifies that the actual value is equal to the given one.
*
* Example:
*
// assertions will pass:
* assertThat(1L).isEqualTo(1L);
* assertThat(-1L).isEqualTo(-1L);
*
* // assertions will fail:
* assertThat(1L).isEqualTo(2L);
* assertThat(1L).isEqualTo(-1L);
*
* @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(long expected) {
longs.assertEqual(info, actual, expected);
return myself;
}
/**
* Verifies that the actual value is not equal to the given one.
*
* Example:
*
// assertions will pass:
* assertThat(1L).isNotEqualTo(2L);
* assertThat(1L).isNotEqualTo(-1L);
*
* // assertion will fail:
* assertThat(1L).isNotEqualTo(1L);
*
* @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(long other) {
longs.assertNotEqual(info, actual, other);
return myself;
}
/** {@inheritDoc} */
@Override
public S isZero() {
longs.assertIsZero(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S isNotZero() {
longs.assertIsNotZero(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S isPositive() {
longs.assertIsPositive(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S isNegative() {
longs.assertIsNegative(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S isNotNegative() {
longs.assertIsNotNegative(info, actual);
return myself;
}
/** {@inheritDoc} */
@Override
public S isNotPositive() {
longs.assertIsNotPositive(info, actual);
return myself;
}
/**
* Verifies that the actual value is less than the given one.
*
* Example:
*
// assertions will pass:
* assertThat(1L).isLessThan(2L);
* assertThat(-2L).isLessThan(-1L);
*
* // assertions will fail:
* assertThat(1L).isLessThan(0L);
* assertThat(1L).isLessThan(1L);
*
* @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(long other) {
longs.assertLessThan(info, actual, other);
return myself;
}
/**
* Verifies that the actual value is less than or equal to the given one.
*
* Example:
*
// assertions will pass:
* assertThat(1L).isLessThanOrEqualTo(2L);
* assertThat(-1L).isLessThanOrEqualTo(-2L);
* assertThat(1L).isLessThanOrEqualTo(1L);
*
* // assertions will fail:
* assertThat(1L).isLessThanOrEqualTo(2L);
* assertThat(-1L).isLessThanOrEqualTo(-2L);
*
* @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(long other) {
longs.assertLessThanOrEqualTo(info, actual, other);
return myself;
}
/**
* Verifies that the actual value is greater than the given one.
*
* Example:
*
// assertions will pass:
* assertThat(1L).isGreaterThan(0L);
* assertThat(-1L).isGreaterThan(-2L);
*
* // assertions will fail:
* assertThat(1L).isGreaterThan(2L);
* assertThat(1L).isGreaterThan(1L);
*
* @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(long other) {
longs.assertGreaterThan(info, actual, other);
return myself;
}
/**
* Verifies that the actual value is greater than or equal to the given one.
*
* Example:
*
// assertions will pass:
* assertThat(2L).isGreaterThanOrEqualTo(1L);
* assertThat(1L).isGreaterThanOrEqualTo(1L);
*
* // assertions will fail:
* assertThat(1L).isGreaterThanOrEqualTo(2L);
* assertThat(-1L).isGreaterThanOrEqualTo(1L);
*
* @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(long other) {
longs.assertGreaterThanOrEqualTo(info, actual, other);
return myself;
}
/** {@inheritDoc} */
@Override
public S isBetween(Long start, Long end) {
longs.assertIsBetween(info, actual, start, end);
return myself;
}
/** {@inheritDoc} */
@Override
public S isStrictlyBetween(Long start, Long end) {
longs.assertIsStrictlyBetween(info, actual, start, end);
return myself;
}
/**
* Verifies that the actual long 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(5L).isCloseTo(7L, within(3L));
*
* // if difference is exactly equals to the offset, it's ok
* assertThat(5L).isCloseTo(7L, within(2L));
*
* // assertion will fail
* assertThat(5L).isCloseTo(7L, within(1L));
*
* @param expected the given long 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(long expected, Offset offset) {
longs.assertIsCloseTo(info, actual, expected, offset);
return myself;
}
/**
* Verifies that the actual long 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(5L).isCloseTo(Long.valueOf(7L), within(3L));
*
* // if difference is exactly equals to the offset, it's ok
* assertThat(5L).isCloseTo(Long.valueOf(7L), within(2L));
*
* // assertion will fail
* assertThat(5L).isCloseTo(Long.valueOf(7L), within(1L));
*
* @param expected the given long 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.
*/
@Override
public S isCloseTo(Long expected, Offset offset) {
longs.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 long:
*
// assertions will pass:
* assertThat(11L).isCloseTo(Long.valueOf(10L), withinPercentage(20L));
*
* // if difference is exactly equals to the computed offset (1L), it's ok
* assertThat(11L).isCloseTo(Long.valueOf(10L), withinPercentage(10L));
*
* // assertion will fail
* assertThat(11L).isCloseTo(Long.valueOf(10L), withinPercentage(5L));
*
* @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(Long expected, Percentage percentage) {
longs.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 long:
*
// assertions will pass:
* assertThat(11L).isCloseTo(10L, withinPercentage(20L));
*
* // if difference is exactly equals to the computed offset (1L), it's ok
* assertThat(11L).isCloseTo(10L, withinPercentage(10L));
*
* // assertion will fail
* assertThat(11L).isCloseTo(10L, withinPercentage(5L));
*
* @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(long expected, Percentage percentage) {
longs.assertIsCloseToPercentage(info, actual, expected, percentage);
return myself;
}
@Override
public S usingComparator(Comparator customComparator) {
super.usingComparator(customComparator);
longs = new Longs(new ComparatorBasedComparisonStrategy(customComparator));
return myself;
}
@Override
public S usingDefaultComparator() {
super.usingDefaultComparator();
longs = Longs.instance();
return myself;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy