Интерфейс Comparable<T>

public interface Comparable<T>

Этот интерфейс накладывает полное упорядочение на объекты каждого класса, реализующего его. Это упорядочение называется естественным упорядочением класса, а метод класса compareTo называется его естественным методом сравнения.

Списки (и массивы) объектов, реализующих этот интерфейс, могут быть автоматически отсортированы с помощью Collections.sort (и Arrays.sort). Объекты, реализующие этот интерфейс, могут использоваться в качестве ключей в отсортированном отображении или в качестве элементов в отсортированном наборе без необходимости указания компаратора.

Естественное упорядочение для класса C считается совместимым с equals тогда и только тогда, когда e1.compareTo(e2) == 0 имеет такое же булево значение, что и e1.equals(e2) для каждого e1 и e2 класса C. Обратите внимание, что null не является экземпляром ни одного класса, а e.compareTo(null) должен вызывать NullPointerException, даже если e.equals(null) возвращает false.

Настоятельно рекомендуется (хотя и не обязательно), чтобы естественные упорядочения были совместимы с equals. Это необходимо, потому что отсортированные наборы (и отсортированные отображения) без явных компараторов ведут себя «странно», когда они используются с элементами (или ключами), чье естественное упорядочение несовместимо с equals. В частности, такой отсортированный набор (или отсортированное отображение) нарушает общее соглашение для набора (или отображения), которое определяется методом equals.

Например, если добавить два ключа a и b, такие что (!a.equals(b) && a.compareTo(b) == 0) в отсортированный набор, не использующий явный компаратор, то вторая операция add возвращает false (и размер отсортированного набора не увеличивается), потому что a и b эквивалентны с точки зрения отсортированного набора.

Практически все основные классы Java, реализующие Comparable имеют естественные упорядочения, совместимые с equals. Одно исключение - java.math.BigDecimal, чье естественное упорядочение приравнивает BigDecimal объекты с одинаковыми значениями и разной точностью (например, 4.0 и 4.00).

Для интересующихся математикой, отношение, определяющее естественное упорядочение для данного класса C, такое:

{(x, y) such that x.compareTo(y) <= 0}.

Коэффициент для этого полного порядка:

{(x, y) such that x.compareTo(y) == 0}.

Непосредственно из соглашения для compareTo следует, что коэффициент является отношением эквивалентности на C, и что естественное упорядочение является полным порядком на C. Когда мы говорим, что естественное упорядочение класса совместимо с equals, мы подразумеваем, что коэффициент для естественного упорядочения является отношением эквивалентности, определенным методом equals(Object) класса:

{(x, y) such that x.equals(y)}.

Этот интерфейс является членом Java Collections Framework.