001/*
002 * Units of Measurement AssertJ Library
003 * Copyright (c) 2005-2021, Werner Keil and others.
004 *
005 * All rights reserved.
006 *
007 * Redistribution and use in source and binary forms, with or without modification,
008 * are permitted provided that the following conditions are met:
009 *
010 * 1. Redistributions of source code must retain the above copyright notice,
011 *    this list of conditions and the following disclaimer.
012 *
013 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
014 *    and the following disclaimer in the documentation and/or other materials provided with the distribution.
015 *
016 * 3. Neither the name of JSR-385, Indriya nor the names of their contributors may be used to endorse or promote products
017 *    derived from this software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
020 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
021 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
022 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
023 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
028 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package tech.uom.lib.assertj.assertions;
031
032import javax.measure.Quantity;
033import org.assertj.core.api.AbstractObjectAssert;
034import org.assertj.core.util.Objects;
035
036/**
037 * Abstract base class for {@link Quantity} specific assertions - Generated by CustomAssertionGenerator.
038 */
039@javax.annotation.Generated(value = "assertj-assertions-generator")
040public abstract class AbstractQuantityAssert<S extends AbstractQuantityAssert<S, A>, A extends Quantity> extends AbstractObjectAssert<S, A> {
041
042    /**
043     * Creates a new <code>{@link AbstractQuantityAssert}</code> to make assertions on actual Quantity.
044     *
045     * @param actual the Quantity we want to make assertions on.
046     */
047    protected AbstractQuantityAssert(A actual, Class<S> selfType) {
048        super(actual, selfType);
049    }
050
051    /**
052     * Verifies that the actual Quantity's unit is equal to the given one.
053     *
054     * @param unit the given unit to compare the actual Quantity's unit to.
055     * @return this assertion object.
056     * @throws AssertionError - if the actual Quantity's unit is not equal to the given one.
057     */
058    public S hasUnit(javax.measure.Unit unit) {
059        // check that actual Quantity we want to make assertions on is not null.
060        isNotNull();
061
062        // overrides the default error message with a more explicit one
063        String assertjErrorMessage = "\nExpecting unit of:\n  <%s>\nto be:\n  <%s>\nbut was:\n  <%s>";
064
065        // null safe check
066        javax.measure.Unit actualUnit = actual.getUnit();
067        if (!Objects.areEqual(actualUnit, unit)) {
068            failWithMessage(assertjErrorMessage, actual, unit, actualUnit);
069        }
070
071        // return the current assertion for method chaining
072        return myself;
073    }
074
075    /**
076     * Verifies that the actual Quantity's value is equal to the given one.
077     *
078     * @param value the given value to compare the actual Quantity's value to.
079     * @return this assertion object.
080     * @throws AssertionError - if the actual Quantity's value is not equal to the given one.
081     */
082    public S hasValue(Number value) {
083        // check that actual Quantity we want to make assertions on is not null.
084        isNotNull();
085
086        // overrides the default error message with a more explicit one
087        String assertjErrorMessage = "\nExpecting value of:\n  <%s>\nto be:\n  <%s>\nbut was:\n  <%s>";
088
089        // null safe check
090        Number actualValue = actual.getValue();
091        if (!Objects.areEqual(actualValue, value)) {
092            failWithMessage(assertjErrorMessage, actual, value, actualValue);
093        }
094
095        // return the current assertion for method chaining
096        return myself;
097    }
098
099}