java.lang
Interface Comparable<T>

All Known Subinterfaces:
Delayed sample code for java.util.concurrent.Delayed definition code for java.util.concurrent.Delayed , Name sample code for javax.naming.Name definition code for javax.naming.Name , ScheduledFuture sample code for java.util.concurrent.ScheduledFuture definition code for java.util.concurrent.ScheduledFuture <V>
All Known Implementing Classes:
Authenticator.RequestorType sample code for java.net.Authenticator.RequestorType definition code for java.net.Authenticator.RequestorType , BigDecimal sample code for java.math.BigDecimal definition code for java.math.BigDecimal , BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger , Boolean sample code for java.lang.Boolean definition code for java.lang.Boolean , Byte sample code for java.lang.Byte definition code for java.lang.Byte , ByteBuffer sample code for java.nio.ByteBuffer definition code for java.nio.ByteBuffer , Calendar sample code for java.util.Calendar definition code for java.util.Calendar , Character sample code for java.lang.Character definition code for java.lang.Character , CharBuffer sample code for java.nio.CharBuffer definition code for java.nio.CharBuffer , Charset sample code for java.nio.charset.Charset definition code for java.nio.charset.Charset , CollationKey sample code for java.text.CollationKey definition code for java.text.CollationKey , CompositeName sample code for javax.naming.CompositeName definition code for javax.naming.CompositeName , CompoundName sample code for javax.naming.CompoundName definition code for javax.naming.CompoundName , Date sample code for java.util.Date definition code for java.util.Date , Date sample code for java.sql.Date definition code for java.sql.Date , Double sample code for java.lang.Double definition code for java.lang.Double , DoubleBuffer sample code for java.nio.DoubleBuffer definition code for java.nio.DoubleBuffer , ElementType sample code for java.lang.annotation.ElementType definition code for java.lang.annotation.ElementType , Enum sample code for java.lang.Enum definition code for java.lang.Enum , File sample code for java.io.File definition code for java.io.File , Float sample code for java.lang.Float definition code for java.lang.Float , FloatBuffer sample code for java.nio.FloatBuffer definition code for java.nio.FloatBuffer , Formatter.BigDecimalLayoutForm sample code for java.util.Formatter.BigDecimalLayoutForm definition code for java.util.Formatter.BigDecimalLayoutForm , FormSubmitEvent.MethodType sample code for javax.swing.text.html.FormSubmitEvent.MethodType definition code for javax.swing.text.html.FormSubmitEvent.MethodType , GregorianCalendar sample code for java.util.GregorianCalendar definition code for java.util.GregorianCalendar , IntBuffer sample code for java.nio.IntBuffer definition code for java.nio.IntBuffer , Integer sample code for java.lang.Integer definition code for java.lang.Integer , JTable.PrintMode sample code for javax.swing.JTable.PrintMode definition code for javax.swing.JTable.PrintMode , KeyRep.Type sample code for java.security.KeyRep.Type definition code for java.security.KeyRep.Type , LdapName sample code for javax.naming.ldap.LdapName definition code for javax.naming.ldap.LdapName , Long sample code for java.lang.Long definition code for java.lang.Long , LongBuffer sample code for java.nio.LongBuffer definition code for java.nio.LongBuffer , MappedByteBuffer sample code for java.nio.MappedByteBuffer definition code for java.nio.MappedByteBuffer , MemoryType sample code for java.lang.management.MemoryType definition code for java.lang.management.MemoryType , ObjectStreamField sample code for java.io.ObjectStreamField definition code for java.io.ObjectStreamField , Proxy.Type sample code for java.net.Proxy.Type definition code for java.net.Proxy.Type , Rdn sample code for javax.naming.ldap.Rdn definition code for javax.naming.ldap.Rdn , RetentionPolicy sample code for java.lang.annotation.RetentionPolicy definition code for java.lang.annotation.RetentionPolicy , RoundingMode sample code for java.math.RoundingMode definition code for java.math.RoundingMode , Short sample code for java.lang.Short definition code for java.lang.Short , ShortBuffer sample code for java.nio.ShortBuffer definition code for java.nio.ShortBuffer , String sample code for java.lang.String definition code for java.lang.String , Thread.State sample code for java.lang.Thread.State definition code for java.lang.Thread.State , Time sample code for java.sql.Time definition code for java.sql.Time , Timestamp sample code for java.sql.Timestamp definition code for java.sql.Timestamp , TimeUnit sample code for java.util.concurrent.TimeUnit definition code for java.util.concurrent.TimeUnit , URI sample code for java.net.URI definition code for java.net.URI , UUID sample code for java.util.UUID definition code for java.util.UUID

public interface Comparable<T>

This interface imposes a total ordering on the objects of each class that implements it. This ordering is referred to as the class's natural ordering, and the class's compareTo method is referred to as its natural comparison method.

Lists (and arrays) of objects that implement this interface can be sorted automatically by Collections.sort (and Arrays.sort). Objects that implement this interface can be used as keys in a sorted map or elements in a sorted set, without the need to specify a comparator.

The natural ordering for a class C is said to be consistent with equals if and only if (e1.compareTo((Object)e2) == 0) has the same boolean value as e1.equals((Object)e2) for every e1 and e2 of class C. Note that null is not an instance of any class, and e.compareTo(null) should throw a NullPointerException even though e.equals(null) returns false.

It is strongly recommended (though not required) that natural orderings be consistent with equals. This is so because sorted sets (and sorted maps) without explicit comparators behave "strangely" when they are used with elements (or keys) whose natural ordering is inconsistent with equals. In particular, such a sorted set (or sorted map) violates the general contract for set (or map), which is defined in terms of the equals method.

For example, if one adds two keys a and b such that (!a.equals((Object)b) && a.compareTo((Object)b) == 0) to a sorted set that does not use an explicit comparator, the second add operation returns false (and the size of the sorted set does not increase) because a and b are equivalent from the sorted set's perspective.

Virtually all Java core classes that implement comparable have natural orderings that are consistent with equals. One exception is java.math.BigDecimal, whose natural ordering equates BigDecimal objects with equal values and different precisions (such as 4.0 and 4.00).

For the mathematically inclined, the relation that defines the natural ordering on a given class C is:

       {(x, y) such that x.compareTo((Object)y) <= 0}.
 
The quotient for this total order is:
       {(x, y) such that x.compareTo((Object)y) == 0}.
 
It follows immediately from the contract for compareTo that the quotient is an equivalence relation on C, and that the natural ordering is a total order on C. When we say that a class's natural ordering is consistent with equals, we mean that the quotient for the natural ordering is the equivalence relation defined by the class's equals(Object) method:
     {(x, y) such that x.equals((Object)y)}.
 

This interface is a member of the Java Collections Framework.

Since:
1.2
See Also:
Comparator sample code for java.util.Comparator definition code for java.util.Comparator , Collections.sort(java.util.List) sample code for java.util.Collections.sort(java.util.List) definition code for java.util.Collections.sort(java.util.List) , Arrays.sort(Object[]) sample code for java.util.Arrays.sort(java.lang.Object[]) definition code for java.util.Arrays.sort(java.lang.Object[]) , SortedSet sample code for java.util.SortedSet definition code for java.util.SortedSet , SortedMap sample code for java.util.SortedMap definition code for java.util.SortedMap , TreeSet sample code for java.util.TreeSet definition code for java.util.TreeSet , TreeMap sample code for java.util.TreeMap definition code for java.util.TreeMap

Method Summary
 int compareTo sample code for java.lang.Comparable.compareTo(T) definition code for java.lang.Comparable.compareTo(T) (T o)
          Compares this object with the specified object for order.
 

Method Detail

compareTo sample code for java.lang.Comparable.compareTo(T) definition code for java.lang.Comparable.compareTo(T)

int compareTo(T o)
Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

In the foregoing description, the notation sgn(expression) designates the mathematical signum function, which is defined to return one of -1, 0, or 1 according to whether the value of expression is negative, zero or positive. The implementor must ensure sgn(x.compareTo(y)) == -sgn(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception iff y.compareTo(x) throws an exception.)

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

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

It is strongly recommended, but not strictly required that (x.compareTo(y)==0) == (x.equals(y)). Generally speaking, any class that implements the Comparable interface and violates this condition should clearly indicate this fact. The recommended language is "Note: this class has a natural ordering that is inconsistent with equals."

Parameters:
o - the Object to be compared.
Returns:
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
Throws:
ClassCastException sample code for java.lang.ClassCastException definition code for java.lang.ClassCastException - if the specified object's type prevents it from being compared to this Object.