Java - Float Class compareTo() Method

Float class compareTo() method: Here, we are going to learn about the compareTo() method of Float class with its syntax and example. By Preeti Jain Last updated : March 21, 2024

Float class compareTo() method

compareTo() method is available in java.lang package.
compareTo() method is used to check equality or inequality for this Float object against the given Float object mathematically or in other words, we can say this method is used to compare two Float objects.
compareTo() 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.
compareTo() method does not throw an exception at the time of comparing Float object.

Syntax

public int compareTo(Float value2);

Parameters

Float value2 – represents the Float object to compare with.

Return Value

The return type of this method is int, it returns an integer value on the basis of following conditions,

It returns 0 if value2 is mathematically equal to value1.
It returns the value < 0 if value2 is mathematically greater than value1.
It returns the value > 0 if value2 is mathematically less than value1.

Example

// Java program to demonstrate the example 
// of compareTo(Float value2) method of 
// Float class

public class CompareToOfFloatClass {
    public static void main(String[] args) {
        // Variables initialization
        float f1 = 30.20f;
        float f2 = 40.20f;

        // Float instance 
        Float value1 = new Float(f1);
        Float value2 = new Float(f2);

        // It compare two Float objects and placed the result 
        // in another variable (compare) of integer type
        int compare = value1.compareTo(value2);

        // Display result
        System.out.println("value1.compareTo(value2): " + compare);

        System.out.println();

        if (compare == 0)
            System.out.println("value1 is equal to value2");
        else if (compare < 0)
            System.out.println("value1 is less than value2");
        else
            System.out.println("value1 is greater than value2");
    }
}

Output

value1.compareTo(value2): -1

value1 is less than value2

Java - Float compare() Method

Java - Float hashCode() Method