java.util
介面 Comparator<T>

型別參數：

T - 此 Comparator 可以比較的物件型別

所有已知實作類別：

Collator, RuleBasedCollator

public interface Comparator<T>

強行對某個物件 collection 進行整體排序 的比較函數。可以將 Comparator 傳遞給 sort 方法（如 Collections.sort 或 Arrays.sort），從而允許在排序順序上實作精確控制。還可以使用 Comparator 來控制某些資料結構（如有序 set或有序映射）的順序，或者為那些沒有自然順序的物件 collection 提供排序。

當且僅當對於一組元素 S 中的每個 e1 和 e2 而言，c.compare(e1, e2)==0 與 e1.equals(e2) 具有相等的布林值時，Comparator c 強行對 S 進行的排序才叫做與 equals 一致 的排序。

當使用具有與 equals 不一致的強行排序能力的 Comparator 對有序 set（或有序映射）進行排序時，應該小心謹慎。假定一個帶顯式 Comparator c 的有序 set（或有序映射）與從 set S 中抽取出來的元素（或鍵）一起使用。如果 c 強行對 S 進行的排序是與 equals 不一致的，那麼有序 set（或有序映射）將是行為“怪異的”。尤其是有序 set（或有序映射）將違背根據 equals 所定義的 set（或映射）的常規協定。

例如，假定使用 Comparator c 將滿足 (a.equals(b) && c.compare(a, b) != 0) 的兩個元素 a 和 b 添加到一個空 TreeSet 中，則第二個 add 操作將返回 true（階層樹 set 的大小將會增加），因為從階層樹 set 的角度來看，a 和 b 是不相等的，即使這與 Set.add 方法的規範相反。

註：通常來說，讓 Comparator 也實作 java.io.Serializable 是一個好主意，因為它們在可序列化的資料結構（像 TreeSet、TreeMap）中可用作排序方法。為了成功地序列化資料結構，Comparator（如果已提供）必須實作 Serializable。

在算術上，定義給定 Comparator c 對給定物件 set S 實施強行排序 的關係式 為：

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

此整體排序的商 (quotient) 為：

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

它直接遵循 compare 的協定，商是 S 上的等價關係，強行排序是 S 上的整體排序。當我們說 c 強行對 S 的排序是與 equals 一致 的時，意思是說排序的商是物件的 equals(Object) 方法所定義的等價關係：

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

此介面是 Java Collections Framework 的成員。

從以下版本開始：

1.2

另請參見：

Comparable, Serializable

方法摘要

int	compare(T o1, T o2) 比較用來排序的兩個參數。
boolean	equals(Object obj) 指示某個其他物件是否“等於”此 Comparator。

方法詳細資訊

compare

int compare(T o1,
            T o2)

比較用來排序的兩個參數。根據第一個參數小於、等於或大於第二個參數分別返回負整數、零或正整數。

在前面的描述中，符號 sgn(expression) 表示 signum 數學函數，根據 expression 的值為負數、0 還是正數，該函數分別返回 -1、0 或 1。

實作程序必須確保對於所有的 x 和 y 而言，都存在 sgn(compare(x, y)) == -sgn(compare(y, x))。（這意味著當且僅當 compare(y, x) 拋出異常時 compare(x, y) 才必須拋出異常。）

實作程序還必須確保關係是可傳遞的：((compare(x, y)>0) && (compare(y, z)>0)) 意味著 compare(x, z)>0。

最後，實作程序必須確保 compare(x, y)==0 意味著對於所有的 z 而言，都存在 sgn(compare(x, z))==sgn(compare(y, z))。

雖然這種情況很普遍，但並不 嚴格要求 (compare(x, y)==0) == (x.equals(y))。一般說來，任何違背這個條件的 Comparator 都應該清楚地指出這一事實。推薦的語言是“注意：此 Comparator 強行進行與 equals 不一致的排序。”

參數：

o1 - 要比較的第一個物件。

o2 - 要比較的第二個物件。

返回：

根據第一個參數小於、等於或大於第二個參數分別返回負整數、零或正整數。

拋出：

ClassCastException - 如果參數的型別不允許此 Comparator 對它們進行比較。

equals

boolean equals(Object obj)

指示某個其他物件是否“等於”此 Comparator。此方法必須遵守 Object.equals(Object) 的常規協定。此外，僅當 指定的物件也是一個 Comparator，並且強行實施與此 Comparator 相同的排序時，此方法才返回 true。因此，comp1.equals(comp2) 意味著對於每個物件參考 o1 和 o2 而言，都存在 sgn(comp1.compare(o1, o2))==sgn(comp2.compare(o1, o2))。

注意，不 覆寫 Object.equals(Object) 方法總是 安全的。然而，在某些情況下，覆寫此方法可以允許程序確定兩個不同的 Comparator 是否強行實施了相同的排序，從而提高性能。

覆寫：

類別 Object 中的 equals

參數：

obj - 要進行比較的參考物件。

返回：

僅當指定的物件也是一個 Comparator，並且強行實施與此 Comparator 相同的排序時才返回 true。

另請參見：

Object.equals(Object), Object.hashCode()