CKTIS / Java
Comparable.compareTo() : ordre naturel en Java
Comparez des objets selon leur ordre naturel. Interprétez le signe du résultat, distinguez l’égalité dans l’ordre de celle définie par equals et choisissez quel objet conserver en cas d’égalité.
Version : Java SE 21
Syntaxe
Java SE 21 — java.lang.Comparable<T>
Interface method: int compareTo(T other);
Call: int result = a.compareTo(b);
Implementation signature for MyType implements Comparable<MyType>: @Override public int compareTo(MyType other)
Generic bound for natural-order helpers: <T extends Comparable<? super T>>Comparable.compareTo() désigne la méthode d’instance int compareTo(T other) de l’interface java.lang.Comparable<T>. L’appel a.compareTo(b) prend un argument et compare a à b selon leur ordre naturel. Un résultat < 0 place a avant b, == 0 les place au même rang et > 0 place a après b. Ne supposez pas que le résultat vaut exactement -1 ou 1. Pour un autre ordre, utilisez un Comparator<T> et appelez compare(a, b).
Permuter les opérandes doit inverser le signe, l’ordre doit être transitif et deux objets de même rang doivent donner le même signe lorsqu’on les compare à un même troisième objet comparable. Dans une hiérarchie de classes, appliquez des règles communes aux instances de la classe de base et des sous-classes si elles sont comparables entre elles. Pour des champs int, utilisez Integer.compare(x, y) plutôt que x - y, qui risque de déborder. Un argument null provoque une NullPointerException ; un type d’argument qui empêche la comparaison provoque une ClassCastException.
La cohérence avec equals est fortement recommandée, mais non obligatoire : a.compareTo(b) == 0 et a.equals(b) devraient donner le même résultat booléen. Documentez tout écart. Par exemple, les valeurs BigDecimal 2.00 et 2.0 sont de même rang dans l’ordre naturel, mais equals renvoie false parce que leurs échelles diffèrent. Un TreeSet sans comparateur les traite comme un seul élément.
La borne générique <T extends Comparable<? super T>> permet de comparer des valeurs de type T même si T hérite de Comparable pour un supertype. Pour chercher un minimum ou un maximum, remplacez le candidat uniquement si le nouvel élément est strictement plus petit (< 0) ou plus grand (> 0), respectivement : vous conservez ainsi le premier élément en cas d’égalité. Avec deux arguments, a.compareTo(b) <= 0 sélectionne a en cas d’égalité.
Avant de ramener une valeur dans un intervalle (clamp), vérifiez min.compareTo(max) <= 0. Renvoyez min en dessous de l’intervalle, max au-dessus et la valeur d’origine sinon, y compris lorsqu’elle est de même rang que l’une des bornes.
Exemples
import java.math.BigDecimal;
public class Main {
static <T extends Comparable<? super T>> T min(T a, T b) {
return a.compareTo(b) <= 0 ? a : b;
}
static <T extends Comparable<? super T>> T clamp(T value, T min, T max) {
if (min.compareTo(max) > 0) {
throw new IllegalArgumentException("min > max");
}
if (value.compareTo(min) < 0) return min;
if (value.compareTo(max) > 0) return max;
return value;
}
public static void main(String[] args) {
BigDecimal a = new BigDecimal("2.00");
BigDecimal b = new BigDecimal("2.0");
BigDecimal high = new BigDecimal("3");
System.out.println("a < high: " + (a.compareTo(high) < 0));
System.out.println("a compares equal to b: " + (a.compareTo(b) == 0));
System.out.println("a.equals(b): " + a.equals(b));
System.out.println("min: " + min(a, b));
System.out.println("clamp: " + clamp(new BigDecimal("4"), a, high));
}
}Résultat
a < high: true a compares equal to b: true a.equals(b): false min: 2.00 clamp: 3
`a` et `b` ont la même valeur numérique, mais des échelles différentes. `min(a, b)` conserve le premier argument, d’où l’affichage de `2.00`. `clamp` renvoie la borne supérieure `3`, car `4` la dépasse.
Leçons associées
- Java · Leçon 5 · Avancé · Version : 2
- Java · Leçon 11 · Avancé · Version : 2
- Java · Leçon 15 · Avancé · Version : 2
- Java · Leçon 48 · Débutant · Version : 2
- Java · Leçon 5 · Intermédiaire · Version : 2