http://www.eclipse.org/platform: Refactoring Core (Eclipse Foundation) 
Copyright (c) 2004, 2008 IBM Corporation and others.
This program and the accompanying materials
are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at
https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0
Contributors:
    IBM Corporation - initial API and implementation

/*******************************************************************************
 * Copyright (c) 2004, 2008 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.ltk.core.refactoring;


Comparator class to compare two refactoring status entries. The general contract of this class is equivalent to the one of class Comparatorfrom the Java Collection Framework. 

This interface is intended to be implemented by clients.



Since:3.1
/**
 * Comparator class to compare two refactoring status entries. The general
 * contract of this class is equivalent to the one of class
 * {@link java.util.Comparator}from the Java Collection Framework.
 * <p>
 * This interface is intended to be implemented by clients.
 * </p>
 *
 * @since 3.1
 */
public interface IRefactoringStatusEntryComparator {

	
Compares two refactoring status entries for order. Returns a negative
integer, zero, or a positive integer as the first status entry is less
than, equal to, or greater than the second.


The implementor must ensure that sgn(compare(x, y)) ==
-sgn(compare(y, x))
for all x and y.




The implementor must ensure that the relation is transitive:
((compare(x, y)>0) && (compare(y, z)>0)) implies
compare(x, z)>0.




Furthermore, the implementer must ensure that compare(x, y)==0
implies that sgn(compare(x, z))==sgn(compare(y, z)) for all
z.



Params:
  • entry1 – the first refactoring status entry to be compared.
  • entry2 – the second refactoring status entry to be compared.
Returns:a negative integer, zero, or a positive integer as the first
        status entry is less than, equal to, or greater than the second.
/**
	 * Compares two refactoring status entries for order. Returns a negative
	 * integer, zero, or a positive integer as the first status entry is less
	 * than, equal to, or greater than the second.
	 * <p>
	 * The implementor must ensure that <code>sgn(compare(x, y)) ==
	 * -sgn(compare(y, x))</code>
	 * for all <code>x</code> and <code>y</code>.
	 * </p>
	 * <p>
	 * The implementor must ensure that the relation is transitive:
	 * <code>((compare(x, y)&gt;0) &amp;&amp; (compare(y, z)&gt;0))</code> implies
	 * <code>compare(x, z)&gt;0</code>.
	 * </p>
	 * <p>
	 * Furthermore, the implementer must ensure that <code>compare(x, y)==0</code>
	 * implies that <code>sgn(compare(x, z))==sgn(compare(y, z))</code> for all
	 * <code>z</code>.
	 * </p>
	 *
	 * @param entry1 the first refactoring status entry to be compared.
	 * @param entry2 the second refactoring status entry to be compared.
	 * @return a negative integer, zero, or a positive integer as the first
	 *         status entry is less than, equal to, or greater than the second.
	 */
	public int compare(RefactoringStatusEntry entry1, RefactoringStatusEntry entry2);
}