What is BooleanUtils.negate in Java?

Overview

The negate() function is a static method of the BooleanUtils class that negates the given boolean value.

How to import BooleanUtils

The definition of BooleanUtils 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>

Note: To see other versions of the commons-lang package, refer to the Maven Repository.

We can import the BooleanUtils class as follows:


import org.apache.commons.lang3.BooleanUtils;

Syntax

public static Boolean negate(final Boolean bool)

Parameters

  • final Boolean bool: The Boolean value to negate.

Return value

The negate function returns the negated boolean value of the given value.

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 BooleanUtils is included in the pom.xml file.

Let’s see the working of code in Main.java:

  • Line 1: We import the BooleanUtils class.
  • Line 6: We define a boolean variable called val.
  • Line 7: We get the negation of val using the BooleanUtils.negate() method.
  • Line 8: We print the boolean value and its negation.

Free Resources