001/*
002 * Units of Measurement Common Library for Java
003 * Copyright (c) 2005-2023, 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.common.util;
031
032import java.util.Comparator;
033import javax.measure.Quantity;
034
035/**
036 * Comparator to sort quantities by natural order, looking both the unit and the value.
037 *
038 * @author <a href="mailto:werner@uom.technology">Werner Keil</a>
039 * @author <a href="mailto:otaviopolianasantana@gmail.com">Otavio Santana</a>
040 * @version 1.0.1
041 * @param <T> the type of quantity
042 * @return <b>Given:</b>
043 *         <p>
044 *         Quantity&lt;Time&gt; day = timeFactory.create(1, Units.DAY);
045 *         </p>
046 *         <p>
047 *         Quantity&lt;Time&gt; hours = timeFactory.create(18, Units.HOUR);
048 *         </p>
049 *         <p>
050 *         Quantity&lt;Time&gt; minutes = timeFactory.create(15, Units.HOUR);
051 *         </p>
052 *         <p>
053 *         Quantity&lt;Time&gt; seconds = timeFactory.create(100, Units.HOUR);
054 *         </p>
055 *         will return: seconds, minutes, hours, day
056 * @since 2.0
057 */
058public class NaturalQuantityComparator<T extends Quantity<T>> implements Comparator<Quantity<T>> {
059
060    @Override
061    public int compare(Quantity<T> q1, Quantity<T> q2) {
062        if (q1.getUnit().equals(q2.getUnit())) {
063            return Double.compare(q1.getValue().doubleValue(), q2.getValue().doubleValue());
064        }
065        return Double.compare(q1.getValue().doubleValue(), q2.to(q1.getUnit()).getValue().doubleValue());
066    }
067}