What is the BooleanUtils.toBooleanDefaultIfNull method in Java?

Overview

In Java, toBooleanDefaultIfNull() is a static method of the BooleanUtils class converts the passed wrapper class Boolean parameter to the primitive Boolean type. The method takes another boolean parameter by the name valueIfNull. valueIfNull is returned if the passed Boolean value is null.

How to import BooleanUtils

The definition of BooleanUtils can be found in the Apache Commons Lang package. We can add this 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 BooleanUtils class in the following way:


import org.apache.commons.lang3.BooleanUtils;

Syntax

public static boolean toBooleanDefaultIfNull(final Boolean bool, final boolean valueIfNull)

Parameters

  • **final Boolean bool**: This is the Boolean value to check.
  • final boolean valueIfNull: This the value to return if bool is null.

Return value

This method returns valueIfNull if bool is null. Otherwise, it returns the primitive version of the bool 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.

Main.java

  • Line 1: We import the BooleanUtils class…
  • Line 6 and 7: We set bool and valueIfNull values.
  • Line 8: We pass two arguments and the toBooleanDefaultIfNull(bool, valueIfNull) function tells if bool is null or not.

Free Resources