TreeMap headMap(K, boolean) in Java

headMap(K, boolean): This method is available in java.util.TreeMap class of Java.

Syntax:

NavigableMap<K, V> java.util.TreeMap.headMap(K toKey, boolean inclusive)

This method takes two arguments. This method returns a view of the portion of this map whose keys are less than (or equal to, if inclusive is true) toKey.

Note: The returned map is backed by this map, so changes in the returned map are reflected in this map, and vice-versa.

Parameters: Two parameters are required for this method.

toKey: high-end point of the keys in the returned map.

inclusive: true if the high-end point is to be included in the returned view.

Returns: a view of the portion of this map whose keys are less than(or equal to, if inclusive is true) toKey.

Throws:

1. ClassCastException - if toKey is not compatible with this map's comparator.

2. NullPointerException - if toKey is null and this map uses natural ordering, or its comparator does not permit null keys.

3. IllegalArgumentException - if this map itself has a restricted range, and toKey lies outside the bounds of the range.

Approach 1: When no exception

Java

import java.util.TreeMap;

public class TreeMapheadMap2 {
    public static void main(String[] args) {

        TreeMap<Integer, String> treeMap = 
              new TreeMap<Integer, String>();

        treeMap.put(2, "Hello");
        treeMap.put(11, "Java");
        treeMap.put(23, "Program");
        treeMap.put(6, "C++");
        treeMap.put(25, "Program");

        Integer toKey = 11;
        boolean inclusion = true;

        System.out.println(treeMap.headMap(toKey,
                                  inclusion));

    }
}

Output:

{2=Hello, 6=C++, 11=Java}

Approach 2: NullPointerException

Java

import java.util.TreeMap;

public class TreeMapheadMap2 {
    public static void main(String[] args) {

        TreeMap<Integer, String> treeMap =
                   new TreeMap<Integer, String>();

        treeMap.put(2, "Hello");
        treeMap.put(11, "Java");
        treeMap.put(23, "Program");
        treeMap.put(6, "C++");
        treeMap.put(25, "Program");

        Integer toKey = null;
        boolean inclusion = true;

        System.out.println(treeMap.headMap(toKey, 
                                       inclusion));

    }
}

Output:

Exception in thread "main" java.lang.NullPointerException: Cannot invoke "java.lang.Comparable.compareTo(Object)" because "k1" is null
	at java.base/java.util.TreeMap.compare(TreeMap.java:1563)
	at java.base/java.util.TreeMap$NavigableSubMap.<init>(TreeMap.java:1646)
	at java.base/java.util.TreeMap$AscendingSubMap.<init>(TreeMap.java:2129)
	at java.base/java.util.TreeMap.headMap(TreeMap.java:1196)