Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.gjt.sp.jedit
Interface MiscUtilities.Compare  view MiscUtilities.Compare download MiscUtilities.Compare.java

All Superinterfaces:
java.util.Comparator
All Known Implementing Classes:
MiscUtilities.MenuItemCompare, MiscUtilities.StringCompare, MiscUtilities.StringICaseCompare
Enclosing interface:
MiscUtilities

public static interface MiscUtilities.Compare
extends java.util.Comparator

An interface for comparing objects. This is a hold-over from they days when jEdit had its own sorting API due to JDK 1.1 compatibility requirements. Use java.util.Comparable instead.


Method Summary
 int compare(java.lang.Object obj1, java.lang.Object obj2)
          Return an integer that is negative, zero or positive depending on whether the first argument is less than, equal to or greater than the second according to this ordering.
 
Methods inherited from interface java.util.Comparator
equals
 

Method Detail

compare

public int compare(java.lang.Object obj1,
                   java.lang.Object obj2)
Description copied from interface: java.util.Comparator
Return an integer that is negative, zero or positive depending on whether the first argument is less than, equal to or greater than the second according to this ordering. This method should obey the following contract:
  • if compare(a, b) < 0 then compare(b, a) > 0
  • if compare(a, b) throws an exception, so does compare(b, a)
  • if compare(a, b) < 0 and compare(b, c) < 0 then compare(a, c) < 0
  • if compare(a, b) == 0 then compare(a, c) and compare(b, c) must have the same sign
To be consistent with equals, the following additional constraint is in place:
  • if a.equals(b) or both a and b are null, then compare(a, b) == 0.

Although it is permissible for a comparator to provide an order inconsistent with equals, that should be documented.

Specified by:
compare in interface java.util.Comparator