Home » Java programming language

Java TreeSet floor() Method with Example

TreeSet Class floor() method: Here, we are going to learn about the floor() method of TreeSet Class with its syntax and example.
Submitted by Preeti Jain, on February 20, 2020

TreeSet Class floor() method

• floor() method is available in java.util package.
• floor() method is used to retrieve the largest element in this TreeSet less than or equal to the given element (ele) otherwise it returns null when no such element exists.
• floor() method is a non-static method, it is accessible with the class object only and if we try to access the method with the class name then we will get an error.
• floor() method may throw an exception at the time of returning matched element.
  • ClassCastException This exception may throw when the given parameter is incompatible to compare with other existing elements.
  • NullPointerException This exception may throw when the given parameter is null exists.

Syntax:

    public Element floor(Element ele);

Parameter(s):

• Element ele – represents the element (ele) to be checked.

Return value:

The return type of the method is Element, it returns largest element in this TreeSet that may be equal to or less than the given element (ele) otherwise it returns null.

Example:

// Java program to demonstrate the example 
// of Element floor(Element ele) method of TreeSet 

import java.util.*;

public class FloorOfTreeSet {
    public static void main(String[] args) {
        // Instantiates a TreeSet object
        TreeSet < String > tree_set = new TreeSet < String > ();

        // By using add() method is to add
        // the given object of this
        // TreeSet 
        tree_set.add("C");
        tree_set.add("C++");
        tree_set.add("JAVA");
        tree_set.add("PHP");
        tree_set.add("SFDC");

        // Display TreeSet
        System.out.println("TreeSet: " + tree_set);

        // By using floor() method is to
        // return the largest element exists
        // less than or equal to the given element
        // i.e. JAVA
        Object Greatest = tree_set.floor("Microservices");

        // Display Greatest
        System.out.println("tree_set.floor(Microservices): " + Greatest);
    }
}

Output

TreeSet: [C, C++, JAVA, PHP, SFDC]
tree_set.floor(Microservices): JAVA