Le Tutoriel de Java SortedMap

SortedMap
Examples
SortedMap Methods
comparator()
firstKey()
lastKey()
subMap(K fromKey, K toKey)
headMap(K toKey)
tailMap(K fromKey)

1. SortedMap

SortedMap est une sous-interface de Map et possède donc toutes les caractéristiques de Map. La différence est que les clefs (keys) de la SortedMap sont triées par ordre croissant en fonction de leur ordre naturel ou selon un Comparator fourni. Comparator est généralement fourni au moment de la création de l'objet SortedMap.

public interface SortedMap<K,V> extends Map<K,V>

Map
ConcurrentMap
ConcurrentNavigableMap
NavigableMap

Voici une comparaison entre Map et SortedMap:

Map<K,V>	SortedMap<K,V> NavigableMap<K,V>
Les clefs dupliquées ne sont pas autorisées.
Autoriser la clef null et les valeurs null.
L'ordre des clefs n'est pas garanti.	Les clefs sont classées dans l'ordre croissant en fonction de leur ordre naturel ou selon un *Comparator* fourni.

Toutes les clefs SortedMap doivent être de type Comparable ou vous devez fournir un Comparator pour SortedMap afin de comparer les clefs. Sinon, ClassCastException sera levée.

Comparator<K>

Si un Comparator est attribué à SortedMap, deux clefs seront comparées l'une à l'autre en utilisant comparator.compare(key1,key2). La cohérence avec les égaux (consistent with equals) doit être respectée. C'est-à-dire, si comparator.compare(key1,key2)=0 donc key1.equals(key2)=true (True pour toutes les clefs dans SortedMap).

Le Tutoriel de Java Comparator

Comparable<K>

Nếu Comparator không được cung cấp cho SortedMap. Tất cả các khoá của SortedMap phải là kiểu Comparable để chúng có thể so sánh với nhau. Các khoá sẽ được so sánh với nhau theo quy tắc key1.equals(key2). Tính nhất quán bằng (equals consistance) cần được tuân thủ. Điều này có nghĩa là key1.equals(key2) và key2.equals(key1) phải trả về cùng một giá trị.

Comprendre Java System.identityHashCode, Object.hashCode et Object.equals
Le Tutoriel de Java Comparable

TreeMap
HashMap
IdentityHashMap
WeakHashMap
LinkedHashMap
EnumMap
ConcurrentHashMap
ConcurrentSkipListMap

2. Examples

La classe String implémente l'interface Comparable, alors les objets String sont comparables et utilisés comme les clefs pour SortedMap.

SortedMapEx1.java

package org.o7planning.sortedmap.ex;

import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;

public class SortedMapEx1 {

    public static void main(String[] args) {
        // Create a SortedMap object.
        SortedMap<String, Integer> map = new TreeMap<String, Integer>();
 
        map.put("B", 100);
        map.put("A", 200);
        map.put("F", 400);
        map.put("D", 500);
        map.put("E", 100);

        System.out.println("--- keySet ---");
        Set<String> keys = map.keySet();

        for (String key : keys) {
            System.out.println(key + " --> " + map.get(key));
        }
        
        System.out.println("--- entrySet ---");
        Set<Map.Entry<String,Integer>> entrySet = map.entrySet();
        
        for (Map.Entry<String,Integer> entry: entrySet) {
            System.out.println(entry.getKey() + " --> " + entry.getValue());
        }
    }
}

Output:

--- keySet ---
A --> 200
B --> 100
D --> 500
E --> 100
F --> 400
--- entrySet ---
A --> 200
B --> 100
D --> 500
E --> 100
F --> 400

Remarque: En règle générale, TreeMap n'autorise pas la clef null, sauf si vous lui attribuez un Comparator qui prend en charge la comparaison null avec les autres valeurs. Vous pouvez trouver un exemple sur TreeMap avec la clef null dans l'article suivant:

Le Tutoriel de Java TreeMap

Par exemple: La classe OrderLineId ci-dessous implémente l'interface Comparable, donc, les objets OrderLineId sont comparables l'un à l'autre:

OrderLineId.java

package org.o7planning.beans;

public class OrderLineId implements Comparable<OrderLineId> {
    private int orderId;
    private int line;

    public OrderLineId(int orderId, int line) {
        this.orderId = orderId;
        this.line = line;
    }

    public int getOrderId() {
        return orderId;
    }

    public int getLine() {
        return line;
    }

    @Override
    public int compareTo(OrderLineId other) {
        if (other == null) {
            return 1; // this > other
        }
        if (this.orderId != other.orderId) {
            return this.orderId - other.orderId;
        }
        return this.line - other.line;
    }
}

SortedMapEx2.java

package org.o7planning.sortedmap.ex;

import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;

import org.o7planning.beans.OrderLineId;

public class SortedMapEx2 {

    public static void main(String[] args) {
        // OrderLineId --> String productName.
        SortedMap<OrderLineId, String> sortedMap = new TreeMap<>();
        
        OrderLineId k21 = new OrderLineId(2, 1);
        OrderLineId k12 = new OrderLineId(1, 2);
        OrderLineId k11 = new OrderLineId(1, 1);
        OrderLineId k22 = new OrderLineId(2, 2);
        OrderLineId k31 = new OrderLineId(3, 1);
        OrderLineId k23 = new OrderLineId(2, 3);
        
        sortedMap.put(k21, "Samsung a71");
        sortedMap.put(k12, "IPhone 12");
        sortedMap.put(k11, "Samsung a51");
        sortedMap.put(k22, "IPhone 11");
        sortedMap.put(k31, "IPhone 7");
        sortedMap.put(k23, "Samsung a51");
        
        Set<OrderLineId> keys = sortedMap.keySet();
        
        for(OrderLineId key: keys)  {
            String productName = sortedMap.get(key);
            System.out.println("OrderId: " + key.getOrderId() //
                       + " / Line: " + key.getLine() + " --> " + productName);
        }
    }
}

Output:

OrderId: 1 / Line: 1 --> Samsung a51
OrderId: 1 / Line: 2 --> IPhone 12
OrderId: 2 / Line: 1 --> Samsung a71
OrderId: 2 / Line: 2 --> IPhone 11
OrderId: 2 / Line: 3 --> Samsung a51
OrderId: 3 / Line: 1 --> IPhone 7

Par exemple: La classe OrderLineKey ci-dessous n'implémente pas l'interface Comparable, donc, les objets OrderLineKey ne sont pas comparables. Dans ce cas-là, vous devez attribuer un Comparatorà SortedMap.

OrderLineKey.java

package org.o7planning.beans;

public class OrderLineKey {
    private int orderId;
    private int line;

    public OrderLineKey(int orderId, int line) {
        this.orderId = orderId;
        this.line = line;
    }

    public int getOrderId() {
        return orderId;
    }

    public int getLine() {
        return line;
    }
}

SortedMapEx3.java

package org.o7planning.sortedmap.ex;

import java.util.Comparator;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;

import org.o7planning.beans.OrderLineKey;

public class SortedMapEx3 {

    public static void main(String[] args) {
        // Comparator.
        OrderLineKeyComparator comparator = new OrderLineKeyComparator();
        
        // Creaate SortedMap with a Comparator.
        // OrderLineKey --> String productName.
        SortedMap<OrderLineKey, String> sortedMap = new TreeMap<>(comparator);

        OrderLineKey k21 = new OrderLineKey(2, 1);
        OrderLineKey k12 = new OrderLineKey(1, 2);
        OrderLineKey k11 = new OrderLineKey(1, 1);
        OrderLineKey k22 = new OrderLineKey(2, 2);
        OrderLineKey k31 = new OrderLineKey(3, 1);
        OrderLineKey k23 = new OrderLineKey(2, 3);

        sortedMap.put(k21, "Samsung a71");
        sortedMap.put(k12, "IPhone 12");
        sortedMap.put(k11, "Samsung a51");
        
        sortedMap.put(null, "<Nothing>");
        
        sortedMap.put(k22, "IPhone 11");
        sortedMap.put(k31, "IPhone 7");
        sortedMap.put(k23, "Samsung a51");

        Set<OrderLineKey> keys = sortedMap.keySet();

        for (OrderLineKey key : keys) {
            String productName = sortedMap.get(key);
            if(key == null)  {
                System.out.println("Null Key --> " + productName);
            } else {
                System.out.println("OrderId: " + key.getOrderId() //
                        + " / Line: " + key.getLine() + " --> " + productName);
            }
        }
    }
}

// This comparator supports null comparison.
class OrderLineKeyComparator implements Comparator<OrderLineKey> {

    @Override
    public int compare(OrderLineKey o1, OrderLineKey o2) {
        if (o1 == o2) {
            return 0;
        }
        if (o1 == null) {
            return -1; // o1 < o2.
        }
        if (o2 == null) {
            return 1; // o1 > o2
        }
        int d = o1.getOrderId() - o2.getOrderId();
        if (d != 0) {
            return d;
        }
        return o1.getLine() - o2.getLine();
    }
}

Output:

Null Key --> <Nothing>
OrderId: 1 / Line: 1 --> Samsung a51
OrderId: 1 / Line: 2 --> IPhone 12
OrderId: 2 / Line: 1 --> Samsung a71
OrderId: 2 / Line: 2 --> IPhone 11
OrderId: 2 / Line: 3 --> Samsung a51
OrderId: 3 / Line: 1 --> IPhone 7

3. SortedMap Methods

SortedMap Methods

Comparator<? super K> comparator();

SortedMap<K,V> subMap(K fromKey, K toKey);
SortedMap<K,V> headMap(K toKey);
SortedMap<K,V> tailMap(K fromKey);

K firstKey();
K lastKey();

// Inherited from Map
Set<K> keySet();
Set<Map.Entry<K, V>> entrySet();      
Collection<V> values();
...

4. comparator()

Comparator<? super K> comparator()

Renvoyer Comparator utilisé pour ordonner les clefs dans ce SortedSet, ou null si ce SortedSet utilise l'ordre naturel de ses clefs.

5. firstKey()

K firstKey()

Renvoyer la première (la plus petite) clé actuellement dans cette SortedMap.

6. lastKey()

K lastKey()

Renvoyer la dernière clef (la plus élevée) actuellement dans cette SortedMap.

7. subMap(K fromKey, K toKey)

SortedMap<K,V> subMap(K fromKey, K toKey)

Renvoyer une vue d'une partie de cette SortedMap qui inclut des mappages avec des clés allant de fromKey à toKey (fromKey =< key < toKey). (Si fromKey et toKey sont égaux, la SortedMap renvoyée est vide).

La SortedMap renvoyée est liée à la SortedMap actuelle. Les changements sur une SortedMap affectent l'autre SortedMap et vice versa.

SortedMap_subMap_ex1.java

package org.o7planning.sortedmap.ex;

import java.util.SortedMap;
import java.util.TreeMap;

public class SortedMap_subMap_ex1 {

    public static void main(String[] args) {
        SortedMap<String, String> myMap = new TreeMap<>();

        myMap.put("A", "VA");
        myMap.put("B", "VB");
        myMap.put("C", "VC");
        myMap.put("D", "VD");
        myMap.put("E", "VE");

        // A Sub Map
        SortedMap<String, String> subMap = myMap.subMap("B", "C1");

        System.out.println(" -- subMap --");
        for (String s : subMap.keySet()) {
            System.out.println(s + " --> " + subMap.get(s));
        }

        subMap.put("B1", "VB1");
        subMap.put("B2", "VB2");

        System.out.println(" -- subMap (after putting some mappings to subMap) --");
        for (String s : subMap.keySet()) {
            System.out.println(s + " --> " + subMap.get(s));
        }

        System.out.println(" -- myMap (after putting some mappings to subMap) --");
        for (String s : myMap.keySet()) {
            System.out.println(s + " --> " + myMap.get(s));
        }
    }
}

Output:

-- subMap --
B --> VB
C --> VC
 -- subMap (after putting some mappings to subMap) --
B --> VB
B1 --> VB1
B2 --> VB2
C --> VC
 -- myMap (after putting some mappings to subMap) --
A --> VA
B --> VB
B1 --> VB1
B2 --> VB2
C --> VC
D --> VD
E --> VE

8. headMap(K toKey)

SortedMap<K,V> headMap(K toKey)

Renvoyer une vue d'une partie de cette SortedMap qui inclut des mappages avec des clefs inférieures à toKey. (key < toKey).

La SortedMap renvoyée est liée à la SortedMap actuelle. Les changements sur une SortedMap affectent l'autre SortedMap et vice versa.

SortedMap_headMap_ex1.java

package org.o7planning.sortedmap.ex;

import java.util.SortedMap;
import java.util.TreeMap;

public class SortedMap_headMap_ex1 {

    public static void main(String[] args) {
        SortedMap<String, String> myMap = new TreeMap<>();

        myMap.put("A", "VA");
        myMap.put("B", "VB");
        myMap.put("C", "VC");
        myMap.put("D", "VD");
        myMap.put("D1", "VD1");
        myMap.put("E", "VE");

        // A Head Map (elements < "D1")
        SortedMap<String, String> headMap = myMap.headMap("D1");

        System.out.println(" -- headMap --");
        for (String s : headMap.keySet()) {
            System.out.println(s + " --> " + headMap.get(s));
        }
    }
}

Output:

-- headMap --
A --> VA
B --> VB
C --> VC
D --> VD

9. tailMap(K fromKey)

SortedMap<K,V> tailMap(K fromKey)

Renvoyer une vue d'une partie de cette SortedMap qui inclut des mappages avec une clef supérieure ou égale à fromKey. (key >= fromKey).

La SortedMap renvoyée est liée à la SortedMap actuelle. Les changements sur une SortedMap affectent l'autre SortedMap et vice versa.

Le Tutoriel de Java SortedMap

1. SortedMap

2. Examples

3. SortedMap Methods

4. comparator()

5. firstKey()

6. lastKey()

7. subMap(K fromKey, K toKey)

8. headMap(K toKey)

9. tailMap(K fromKey)

Tutoriels de Java Collections Framework

Tutoriels de Java Collections Framework

Articles les plus récents