Java Boolean getBoolean() Method

The Boolean.getBoolean() method in Java is used to determine the boolean value of a system property.

Table of Contents

1. Introduction
2. getBoolean() Method Syntax
3. Examples
   • Checking a System Property
   • Using with Default Values
4. Real-World Use Case
5. Conclusion

Introduction

The Boolean.getBoolean() method is a static method in the Boolean class in Java. It returns true if and only if the system property with the specified name exists and is equal to the string "true" (ignoring case). This method is useful for retrieving boolean values from system properties, which can be used for configuration and feature toggling.

getBoolean()() Method Syntax

The syntax for the getBoolean() method is as follows:

public static boolean getBoolean(String name)

• name: The name of the system property.

The method returns:

• true if the system property named by the argument exists and is equal to the string "true" (ignoring case).
• false otherwise.

Examples

Checking a System Property

The getBoolean() method can be used to check if a system property is set to "true".

Example

public class GetBooleanExample {
    public static void main(String[] args) {
        // Setting a system property for demonstration purposes
        System.setProperty("myProperty", "true");

        boolean propertyValue = Boolean.getBoolean("myProperty");

        System.out.println("System property 'myProperty' is: " + propertyValue);
    }
}

Output:

System property 'myProperty' is: true

Using with Default Values

The getBoolean() method only checks if the system property is set to "true". If the property does not exist, it returns false.

Example

public class GetBooleanDefaultExample {
    public static void main(String[] args) {
        // System property is not set
        boolean propertyValue = Boolean.getBoolean("nonExistentProperty");

        System.out.println("System property 'nonExistentProperty' is: " + propertyValue);
    }
}

Output:

System property 'nonExistentProperty' is: false

Real-World Use Case

Enabling Debug Mode

In an application, you can use the getBoolean() method to enable or disable debug mode based on a system property.

Example

public class DebugModeExample {
    public static void main(String[] args) {
        // Set the system property for debug mode
        System.setProperty("debugMode", "true");

        if (Boolean.getBoolean("debugMode")) {
            System.out.println("Debug mode is enabled.");
            // Additional debug code
        } else {
            System.out.println("Debug mode is disabled.");
        }
    }
}

Output:

Debug mode is enabled.

Configuring Application Features

The getBoolean() method can also be used to toggle application features based on system properties.

Example

public class FeatureToggleExample {
    public static void main(String[] args) {
        // Set the system property to enable a feature
        System.setProperty("newFeature", "true");

        if (Boolean.getBoolean("newFeature")) {
            System.out.println("New feature is enabled.");
            // Code for the new feature
        } else {
            System.out.println("New feature is disabled.");
        }
    }
}

Output:

New feature is enabled.

Conclusion

The Boolean.getBoolean() method in Java is a convenient way to retrieve boolean values from system properties. By understanding how to use this method, you can efficiently manage configuration settings and feature toggles in your Java applications. Whether you are checking for system properties to enable debug mode or toggling features, the getBoolean() method provides a reliable solution for these tasks.