Интерфейс 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. Одно исключение — BigDecimal, естественный порядок которого сопоставляет объекты BigDecimal с одинаковыми числовыми значениями и различными представлениями (например, 4.0 и 4.00). Для того, чтобы BigDecimal.equals() вернуло true, представление и числовое значение двух BigDecimal объектов должны быть одинаковыми.

Для математически настроенных, отношение, определяющее естественный порядок в заданном классе 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)}. 

Другими словами, когда естественный порядок класса согласован с equals, классы эквивалентности, определенные отношением эквивалентности метода equals, и классы эквивалентности, определенные частным метода compareTo, совпадают.

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