What is the ComparableUtils.gt() method in Java?

The gt() method

gt() is a staticthe methods in Java that can be called without creating an object of the class. method of the ComparableUtils that returns a predicate for the passed value. The predicate checks for the “greater than” condition against the passed value.

Refer to What is a Java predicate? to learn more about the predicate in Java.

How to import ComparableUtils

The definition of ComparableUtils can be found in the Apache Commons Lang package, which we can add to the Maven project by adding the following dependency to the pom.xml file:


<dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.12.0</version>
</dependency>

For other versions of the commons-lang package, refer to the Maven Repository.

You can import the ComparableUtils class in the following way:


import org.apache.commons.lang3.compare.ComparableUtils;

Syntax


public static <A extends Comparable<A>> Predicate<A> gt(final A b)

Parameters

  • final A b: This is the object to be compared to in the returned predicate.

Return value

This method returns a predicate.

Code

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>test</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.12.0</version>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>2.1</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                        <configuration>
                            <transformers>
                                <transformer
                                        implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                    <mainClass>Main</mainClass>
                                </transformer>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

Explanation

The maven dependency for ComparableUtils is included in the pom.xml file.

Main.java

  • Lines 1-2: We import the relevant classes are imported.
  • Line 7: We define an integer variable called val.
  • Line 8: We pass val as the parameter to the ComparableUtils.gt() method. This returns a predicate called greaterThan.
  • Line 9: We define an integer test value called testVal.
  • Line 10: We use the test() method of the predicate to test whether testVal is greater than val. The comparison’s result is printed.
  • Line 11: We assign a new test value to testVal.
  • Line 12: We use the test() method of the predicate to test whether testVal is greater than val. The comparison’s result is printed.

Free Resources