Understanding Java's Comparable Interface and How to Implement It

In Java, many core classes such as String implement the Comparable interface, which enables natural ordering through the compareTo method. This allows utilities like Arrays.sort or Collections.sort to automatically order elements.

Example with a String array:

String[] strArr = {"A","B","C","E","D"};
Arrays.sort(strArr);
for (String s : strArr) {
    System.out.print(s + ";");
}

The output is A;B;C;D;E; , showing that the natural ordering defined by String.compareTo sorts the strings alphabetically.

If a custom class does not implement Comparable , sorting will fail with a ClassCastException because the runtime cannot determine a comparison rule:

public class ComparableDemo {
    public static void main(String[] args) {
        Object[] objArray = {new Person(20, "jack"), new Person(17, "tom"), new Person(27, "aj")};
        for (Object o : objArray) {
            System.out.print(o.toString());
        }
        Arrays.sort(objArray); // throws ClassCastException
    }
}

public class Person {
    private Integer age;
    private String name;
    public Person(int age, String name) { this.age = age; this.name = name; }
    @Override
    public String toString() { return "Person [age=" + age + ", name=" + name + "]"; }
}

To enable sorting, the class must implement Comparable and define a comparison rule, typically based on a field such as age :

public class Person implements Comparable {
    private Integer age;
    private String name;
    public Person(int age, String name) { this.age = age; this.name = name; }
    @Override
    public String toString() { return "Person [age=" + age + ", name=" + name + "]"; }
    @Override
    public int compareTo(Object o) {
        Person p = (Person) o;
        return this.age - p.age; // ascending order by age
    }
}

After adding the interface, sorting works as expected:

Person[age=20, name=jack]Person[age=17, name=tom]Person[age=27, name=aj]
Person[age=17, name=tom]Person[age=20, name=jack]Person[age=27, name=aj]

The compareTo method contract requires that the sign of x.compareTo(y) be the opposite of y.compareTo(x) , that it be transitive, and that equality implied by compareTo be consistent with equals whenever possible.

Signature of the method (as defined in the Java Collections Framework):

int compareTo(T o)

This method returns a negative integer, zero, or a positive integer when the current object is less than, equal to, or greater than the specified object, respectively, and may throw ClassCastException if the objects are not mutually comparable.