鸿蒙OS Comparable

Comparable

public interface Comparable<T>

该接口对实现它的每个类的对象进行了总排序。这种排序称为类的自然排序，类的 compareTo 方法称为其自然比较方法。

实现此接口的对象列表（和数组）可以通过 Collections#sort(List)（和 [Arrays#sort(Object])）自动排序。实现此接口的对象可以用作 SortedMap 中的键或用作 SortedSet 中的元素，而无需指定 Comparator。

当且仅当 e1.compareTo(e2) == 0 对于类 C 的每个 e1 和 e2 具有与 e1.equals(e2) 相同的布尔值时，类 C 的自然排序被称为与 equals 一致。注意null 不是任何类的实例，即使 e.equals(null) 返回 false，e.compareTo(null) 也应该抛出 NullPointerException。

强烈建议（尽管不是必需的）自然排序与 equals 一致。之所以如此，是因为没有显式比较器的排序集（和排序映射）在与自然顺序与等于不一致的元素（或键）一起使用时表现“奇怪”。特别是，这样的排序集合（或排序映射）违反了集合（或映射）的一般合同，该合同是根据 equals 方法定义的。

例如，如果添加两个键 a 和 b 使得 (!a.equals(b) && a.compareTo(b) == 0) 到不使用显式比较器的排序集，则第二个添加操作返回 false （并且排序集的大小不会增加）因为从排序集的角度来看 a 和 b 是等价的。

几乎所有实现 Comparable 的 Java 核心类都具有与 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 一致时，我们的意思是 自然排序是类的 Object#equals(Object) 方法定义的等价关系：

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

此接口是 Java 集合框架的成员。

方法总结

修饰符和类型	方法	描述
int	compareTo(T o)	将此对象与指定对象进行比较以进行排序。

方法详情

compareTo

int compareTo(T o)

将此对象与指定对象进行比较以进行排序。返回负整数、零或正整数，因为此对象小于、等于或大于指定对象。

实现者必须确保所有 x 和 y 的 sgn(x.compareTo(y)) == -sgn(y.compareTo(x))。 （这意味着如果 y.compareTo(x) 抛出异常，则 x.compareTo(y) 必须抛出异常。）

实现者还必须确保关系是可传递的：(x.compareTo(y)>0 && y.compareTo(z)>0) 意味着 x.compareTo(z)>0。

最后，实现者必须确保 x.compareTo(y)==0 意味着 sgn(x.compareTo(z)) == sgn(y.compareTo(z))，对于所有 z。

强烈建议但不严格要求 (x.compareTo(y)==0) == (x.equals(y))。一般来说，任何实现了 Comparable 接口并违反此条件的类都应该清楚地表明这一事实。推荐的语言是“注意：这个类有一个与equals不一致的自然顺序。”

在前面的描述中，符号sgn(expression)表示数学符号函数，它被定义为根据表达式的值是负数、零还是正数返回-1、0或1之一。

参数：

参数名称	参数描述
o	the object to be compared.

返回:

负整数、零或正整数，因为此对象小于、等于或大于指定对象。

Throws:

Throw名称	Throw描述
NullPointerException	如果指定的对象为空
ClassCastException	如果指定对象的类型阻止它与此对象进行比较。