What is the ExceptionUtils.getMessage() method in Java?

Overview

In Java, getMessage() is a staticThese are the methods in Java that can be called without creating an object of the class. method of the ExceptionUtils class that is used to get the message summarizing the exception. The format of the message returned is as follows:

{ClassNameWithoutPackage}: {ThrowableMessage}

For example,

NullPointerException: Value not found

where NullPointerException is the ClassNameWithoutPackage and Value not found is the ThrowableMessage.

Import ExceptionUtils

The definition of ExceptionUtils 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.

We can import the ExceptionUtils class as follows:

import org.apache.commons.lang3.exception.ExceptionUtils;

Syntax

public static String getMessage(final Throwable th)

Parameters

This method takes a parameter, final Throwable th, which represents the throwable to summarize.

Return value

This method returns the summary of the throwable as a string.

Example

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

Main.java

  • Line 1: We import the ExceptionUtils class.
  • Line 6: We define an instance of the RuntimeException class with the message Value not found.
  • Line 7: We use the getMessage() method to print the summary of the exception.

Free Resources

License: Creative Commons-Attribution-ShareAlike 4.0 (CC-BY-SA 4.0)