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

@FunctionalInterface
public interface Comparator<T>

Функция сравнения, которая накладывает полный порядок на некоторое множество объектов. Компараторы могут быть переданы методу сортировки (например, Collections.sort или Arrays.sort), чтобы обеспечить точный контроль над порядком сортировки. Компараторы также могут использоваться для управления порядком некоторых структур данных (таких как sorted sets или sorted maps), или для предоставления порядка для наборов объектов, у которых нет natural ordering.

Порядок, налагаемый компаратором c на набор элементов S , считается совместимым с equals тогда и только тогда, когда c.compare(e1, e2)==0 имеет то же булево значение, что и e1.equals(e2) для каждого e1 и e2 в S.

Следует проявлять осторожность при использовании компаратора, способного наложить порядок, несовместимый с equals, для упорядочивания упорядоченного набора (или упорядоченного отображения). Предположим, что упорядоченный набор (или упорядоченное отображение) с явным компаратором c используется с элементами (или ключами), взятыми из множества S. Если порядок, налагаемый c на S , несовместим с equals, упорядоченный набор (или упорядоченное отображение) будет вести себя "странно". В частности, упорядоченный набор (или упорядоченное отображение) нарушит общий контракт для множества (или отображения), который определен в терминах equals.

Например, предположим, что добавляются два элемента a и b , такие что (a.equals(b) && c.compare(a, b) != 0) в пустой TreeSet с компаратором c. Вторая операция add вернет true (и размер набора возрастает) потому, что a и b не эквивалентны с точки зрения набора, даже если это противоречит спецификации метода Set.add.

Примечание: В общем случае рекомендуется, чтобы компараторы также реализовывали java.io.Serializable, так как они могут использоваться в качестве методов упорядочивания в сериализуемых структурах данных (например, TreeSet, TreeMap). Для успешной сериализации структуры данных, компаратор (если он предоставлен) должен реализовывать Serializable.

Для интересующихся математикой, отношение, определяющее налагаемый порядок, который заданный компаратор c накладывает на заданный набор объектов S:

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

Фактор для этого полного порядка:

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

Из контракта для compare непосредственно следует, что фактор является отношением эквивалентности на S, и что налагаемый порядок является полным порядком на S. Когда мы говорим, что порядок, налагаемый c на S , совместим с equals, мы подразумеваем, что фактор для порядка является отношением эквивалентности, определенным методом(ами) equals(Object) объектов:

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

В отличие от Comparable, компаратор может по желанию допускать сравнение аргументов null, сохраняя при этом требования к отношению эквивалентности.

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