Интерфейс 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.

Методы

compareTo

int compareTo(T o)

Параметры:

o - сравниваемый объект.

Возвращает:

отрицательное целое число, ноль или положительное целое число, если этот объект меньше, равен или больше указанного объекта.

Исключения:

NullPointerException - если указанный объект равен null

ClassCastException - если тип указанного объекта не позволяет сравнить его с этим объектом.