Java Utility Library

Java TreeMap - floorKey() Method



The java.util.TreeMap.floorKey() method returns the greatest key less than or equal to the given key, or null if there is no such key.

Syntax

public K floorKey(K key)

Here, K is the type of key maintained by the container.


Parameters

key Specify the key.

Return Value

Returns the greatest key less than or equal to key, or null if there is no such key.

Exception

  • Throws ClassCastException, if the specified key cannot be compared with the keys currently in the map.
  • Throws NullPointerException, if the specified key is null and this map uses natural ordering, or its comparator does not permit null keys.

Example:

In the example below, the java.util.TreeMap.floorKey() method returns the greatest key less than or equal to the given value.

import java.util.*;

public class MyClass {
  public static void main(String[] args) {
    //creating a treemap
    TreeMap<Integer, String> MyMap = new TreeMap<Integer, String>();

    //populating the map
    MyMap.put(102, "John");
    MyMap.put(103, "Marry");
    MyMap.put(101, "Kim");
    MyMap.put(104, "Jo");
    MyMap.put(105, "Sam");

    //printing the map
    System.out.println("MyMap contains: " + MyMap); 

    //printing the greatest key less than or equal to 110.
    System.out.println("Floor Key for 110 is: " + MyMap.floorKey(110));     
  }
}

The output of the above code will be:

MyMap contains: {101=Kim, 102=John, 103=Marry, 104=Jo, 105=Sam}
Floor Key for 110 is: 105

❮ Java.util - TreeMap