/*
 * #%L
 * SciJava constants facilitating a consistent priority order.
 * %%
 * Copyright (C) 2022 - 2024 SciJava developers.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package org.scijava.priority;

/**
 * An object that can be sorted according to priority.
 *
 * @author Curtis Rueden
 */
public interface Prioritized<T extends Prioritized<T>> extends Comparable<T> {

	/**
	 * The sort priority of the object.
	 *
	 * @see Priority
	 */
	double priority();

	// -- Comparable methods --

	@Override
	default int compareTo(final T that) {
		if (that == null) return 1;

		// compare priorities
		final var priorityCompare = compare(this, that);
		if (priorityCompare != 0) return priorityCompare;

		// compare class names as a tiebreaker
        var thisName = getClass().getName();
        var thatName = that.getClass().getName();
		return thisName.compareTo(thatName);
	}


	/**
	 * Compares two {@link Prioritized} objects, based on their
	 * {@link Prioritized#priority()} value. Higher priorities (e.g.
	 * {@link Priority#HIGH}) compare <em>less than</em> lower ones (e.g.
	 * {@link Priority#LOW}, so that a natural sort of {@link Prioritized} objects
	 * will result in the higher priority items earlier in the sorted list.
	 * If {@code null} is passed as an argument, that argument's priority is
	 * considered to be negative infinity&mdash;i.e., lower priority than all
	 * non-{@code null} objects, resulting in all {@code null} values being
	 * sorted to the end of the list.
	 * <p>
	 * Note: this method provides a natural ordering that may be inconsistent with
	 * equals. That is, two unequal objects may often have the same priority, and
	 * thus return 0 when compared in this fashion. Hence, if this method is used
	 * as a basis for implementing {@link Comparable#compareTo} or
	 * {@link java.util.Comparator#compare}, that implementation may want to
	 * impose logic beyond that of this method, for breaking ties, if a total
	 * ordering consistent with equals is always required.
	 * </p>
	 *
	 * @param p1 The first prioritized object to compare.
	 * @param p2 The second prioritized object to compare.
	 * @return -1 if {@code p1}'s priority is higher than {@code p2}'s, 1 if
	 *         {@code p2}'s priority is higher than {@code p1}'s, or 0 if they
	 *         have the same priority.
	 */
	static <T extends Prioritized<T>> int compare(
		final Prioritized<T> p1, final Prioritized<T> p2)
	{
		final var priority1 = p1 == null ? Double.NEGATIVE_INFINITY : p1.priority();
		final var priority2 = p2 == null ? Double.NEGATIVE_INFINITY : p2.priority();
		if (priority1 == priority2) return 0;
		// NB: We invert the ordering here, so that large values come first,
		// rather than the typical natural ordering of smaller values first.
		return priority1 > priority2 ? -1 : 1;
	}
}
