KennisbankExamencentrum
NL · NLNederlands (Nederland)
Taal kiezen13

CKTIS / Java

Comparable.compareTo(): natuurlijke ordening in Java

Vergelijk objecten volgens hun natuurlijke ordening. Lees het teken van het resultaat, onderscheid gelijke rang van gelijkheid volgens equals en kies welk object je bewaart.

Versie: Java SE 21

Syntax

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() staat voor de instantiemethode int compareTo(T other) van de interface java.lang.Comparable<T>. De aanroep a.compareTo(b) neemt één argument en vergelijkt a met b volgens hun natuurlijke ordening. Bij < 0 komt a vóór b, bij == 0 staan ze op gelijke rang en bij > 0 komt a na b. Ga er niet van uit dat de uitkomst precies -1 of 1 is. Gebruik voor een andere ordening een Comparator<T> en roep compare(a, b) aan.

Verwisselen van de operanden moet het teken omkeren. De ordening moet transitief zijn en twee objecten van gelijke rang moeten hetzelfde teken opleveren bij vergelijking met een willekeurig derde vergelijkbaar object. Hanteer in een klassenhiërarchie dezelfde ordeningsregels voor instanties van de basisklasse en subklassen als ze onderling vergelijkbaar zijn. Gebruik voor int-velden Integer.compare(x, y) in plaats van x - y, want de aftrekking kan overlopen. Een null-argument leidt tot een NullPointerException; als het type van het argument vergelijking verhindert, volgt een ClassCastException.

Consistentie met equals wordt sterk aanbevolen, maar is niet verplicht: a.compareTo(b) == 0 en a.equals(b) zouden dezelfde booleaanse uitkomst moeten geven. Documenteer afwijkingen. Zo hebben de BigDecimal-waarden 2.00 en 2.0 gelijke rang in de natuurlijke ordening, maar geeft equals false omdat hun schaal verschilt. Een TreeSet zonder comparator behandelt ze als hetzelfde element.

Met de generieke bovengrens <T extends Comparable<? super T>> kun je waarden van type T vergelijken, ook als T Comparable voor een supertype erft. Vervang bij het zoeken naar een minimum of maximum je huidige keuze alleen als het nieuwe element strikt kleiner (< 0) of groter (> 0) is. Zo bewaar je het eerste element bij gelijke rang. Met twee argumenten kiest a.compareTo(b) <= 0 bij gelijke rang voor a.

Controleer voordat je een waarde tot een bereik beperkt (clamp) of min.compareTo(max) <= 0 geldt. Geef onder het bereik min terug, erboven max en anders de oorspronkelijke waarde, ook bij gelijke rang met een van de grenzen.

Voorbeelden

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));
    }
}

Resultaat

a < high: true
a compares equal to b: true
a.equals(b): false
min: 2.00
clamp: 3

`a` en `b` zijn numeriek gelijk, maar hebben verschillende schalen. `min(a, b)` behoudt het eerste argument, zodat `2.00` wordt afgedrukt. `clamp` geeft de bovengrens `3` terug omdat `4` daarboven ligt.

Gerelateerde lessen

  • Java · Les 5 · Gevorderd · Versie: 2
  • Java · Les 11 · Gevorderd · Versie: 2
  • Java · Les 15 · Gevorderd · Versie: 2
  • Java · Les 48 · Basis · Versie: 2
  • Java · Les 5 · Gemiddeld · Versie: 2

Bronnen