Java TreeMap

Java TreeMap

A TreeMap is a collection that stores key/value pairs in sorted order by key.

It is part of the java.util package and implements the Map interface.

Create a TreeMap

Create a TreeMap that stores String keys and String values:

import java.util.TreeMap; // Import the TreeMap class

TreeMap<String, String> capitalCities = new TreeMap<>();

Now you can use methods like put(), get(), and remove() to manage sorted key/value pairs.

Add Items

Use the put() method to add key/value pairs:

import java.util.TreeMap;

public class Main {
  public static void main(String[] args) {
    TreeMap<String, String> capitalCities = new TreeMap<>();
    capitalCities.put("England", "London");
    capitalCities.put("India", "New Dehli");
    capitalCities.put("Austria", "Wien");
    capitalCities.put("Norway", "Oslo");
    capitalCities.put("Norway", "Oslo"); // Duplicate
    capitalCities.put("USA", "Washington DC");

    System.out.println(capitalCities);
  }
}

Access an Item

Use get() with the key to access its value:

capitalCities.get("England");

Remove Items

Use remove() to delete a key/value pair by key:

capitalCities.remove("England");

Use clear() to remove all items:

capitalCities.clear();

TreeMap Size

Use size() to count the number of key/value pairs:

capitalCities.size();

Note: The size only counts unique keys. If a key is added more than once, only the latest value is kept.

Loop Through a TreeMap

Loop through the items of a TreeMap with a for-each loop.

Note: Use the keySet() method if you only want the keys, and use the values() method if you only want the values:

// Print keys
for (String i : capitalCities.keySet()) {
  System.out.println(i);
}

// Print values
for (String i : capitalCities.values()) {
  System.out.println(i);
}

// Print keys and values
for (String i : capitalCities.keySet()) {
  System.out.println("key: " + i + " value: " + capitalCities.get(i));
}

TreeMap vs HashMap

The var Keyword

From Java 10, you can use the var keyword to declare a TreeMap variable without writing the type twice. The compiler figures out the type from the value you assign.

This makes code shorter, but many developers still use the full type for clarity. Since var is valid Java, you may see it in other code, so it's good to know that it exists:

// Without var
TreeMap<String, String> capitalCities = new TreeMap<String, String>();

// With var
var capitalCities = new TreeMap<String, String>();

The Map Interface

Note: Sometimes you will see both Map and TreeMap in Java code, like this:

import java.util.Map;
import java.util.TreeMap;

Map<String, String> capitalCities = new TreeMap<>();

This means the variable (capitalCities) is declared as a Map (the interface), but it stores a TreeMap object (the actual map). Since TreeMap implements the Map interface, this is possible.

It works the same way, but some developers prefer this style because it gives them more flexibility to change the type later.