Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Java

Comparable.compareTo(): přirozené uspořádání v Javě

Porovnávejte objekty podle přirozeného uspořádání. Vyhodnoťte znaménko výsledku, odlište shodu v pořadí od rovnosti podle equals a rozhodněte, který objekt při shodě ponechat.

Verze: 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() označuje instanční metodu int compareTo(T other) rozhraní java.lang.Comparable<T>. Volání a.compareTo(b) přijímá jeden argument a porovnává a s b podle jejich přirozeného uspořádání. Výsledek < 0 znamená, že a patří před b, == 0 znamená shodu v pořadí a > 0 znamená, že a patří za b. Nespoléhejte na to, že výsledkem je přesně -1 nebo 1. Pro jiné uspořádání použijte Comparator<T> a zavolejte compare(a, b).

Záměna operandů musí obrátit znaménko, uspořádání musí být tranzitivní a objekty se shodným pořadím musí při porovnání s libovolným třetím porovnatelným objektem dávat stejné znaménko. V hierarchii tříd používejte společná pravidla pro instance základní a odvozených tříd, pokud je lze vzájemně porovnávat. Položky typu int porovnávejte pomocí Integer.compare(x, y), nikoli pomocí x - y, protože při odečítání může dojít k přetečení. Argument null vyvolá NullPointerException; argument, jehož typ znemožňuje porovnání, vyvolá ClassCastException.

Soulad s equals se důrazně doporučuje, ale není povinný: a.compareTo(b) == 0 a a.equals(b) by měly dát stejný logický výsledek. Případnou odchylku zdokumentujte. Například hodnoty BigDecimal 2.00 a 2.0 mají v přirozeném uspořádání stejné pořadí, ale equals vrátí false, protože mají různou škálu. TreeSet bez komparátoru je považuje za tentýž prvek.

Generické omezení <T extends Comparable<? super T>> umožňuje porovnávat hodnoty typu T, i když T dědí Comparable pro nadtyp. Při hledání minima nebo maxima nahraďte dosavadní prvek, jen pokud je nový prvek ostře menší (< 0), respektive větší (> 0). Při shodě tak zůstane první prvek. U dvou argumentů podmínka a.compareTo(b) <= 0 při shodě vybere a.

Před omezením hodnoty na interval (clamp) ověřte min.compareTo(max) <= 0. Pod intervalem vraťte min, nad ním max, jinak původní hodnotu, a to i tehdy, když má stejné pořadí jako jedna z mezí.

Příklady

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

Výsledek

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

`a` a `b` mají stejnou číselnou hodnotu, ale různou škálu. `min(a, b)` ponechá první argument, takže se vypíše `2.00`. `clamp` vrátí horní mez `3`, protože ji `4` překračuje.

Související lekce

  • Java · Lekce 5 · Pokročilá · Verze: 2
  • Java · Lekce 11 · Pokročilá · Verze: 2
  • Java · Lekce 15 · Pokročilá · Verze: 2
  • Java · Lekce 48 · Základní · Verze: 2
  • Java · Lekce 5 · Středně pokročilá · Verze: 2

Zdroje