StringUtils - Apache common Lang3

Table of contents

Reading Time: 2 minutes

In this blog, we will learn about the StringUtils class. It provides some nice utilities that deal with Strings as compare to java.lang.String. Before discussing its methods, let’s see one example.

Movie movie = new Movie()
String name = movie.getName();
if(name.isEmpty()){
}

what if the movie’s name is Null. 🤔

Exception in thread "main" java.lang.NullPointerException

Then definitely it will throw a Null Pointer Exception.
Yes, java.lang.String methods are not null safe.
OK, let me modify the above code.

 Movie movie = new Movie()
String name = movie.getName();
if(name !=null && name.isEmpty()){
}

Now, no more null pointer exception. But I think these null checks make your code dirty.
So, Here comes StringUtils class in the picture. Though there are plenty of third-party libraries that solve the problem, here I am discussing StringUtils only.

What is StringUtils?

StringUtils class is provided by Apache Commons Lang 3 Library which consists of null safe methods. The class consists a lot many utility methods, all of which are very difficult to cover here, so we’ll take a look at some of the widely used methods. To get started with the StringUtils first thing we need to do is to add the dependency to our Maven-Project.

This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters

Show hidden characters

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

view raw

dependency

hosted with ❤ by GitHub

Now let’s quickly go through the utility methods it provides:

1) isEmpty() – Checks if the String contains text

String name = null;
if(StringUtils.isEmpty(name)) {
System.out.println("Its null"); // print Its null
}

2) isBlank() – Checks if the String contains text and moreover it also checks for the whitespace.

String name = " ";
if(StringUtils.isBlank(name)) {
System.out.println("name is blank ");//print name is Blank
}

isBlank() = (isEmpty() + check whether the text contain white space)

StringUtils also has isNotBlank() and isNotEmpty() methods which are equivalent to !isBlank() and !isEmpty() respectively.

3) swapCase() : Swaps the case of the text. It simply converts lowercase to uppercase and viceversa.

String name = StringUtils.swapCase("Hello PeoPle");
System.out.println(name); // print hELLO pEOpLE

In case of a null and empty string, swapcase() simply return null and empty string respectively.

4) trim(): Removes every whitespace and control character from the begining and the end of the received string.

String name = StringUtils.trim(" Bhawna ")
System.out.println(name); // prints: Bhawna

String anotherName = StringUtils.trim("\r\n Bhawna ")
System.out.println(name); // prints: Bhawna

5) join(): Joins the elements of the provided array into a single string.

String [] name = {"A", "B", "C", "D", "E"}
String value = StringUtils.join(name, ",")
System.out.println(value) // print A,B,C,D,E (as a single string)

You can get all the methods here .

Conclusion

StringUtils provide the same method as String class but these methods are null safe. So basically if you want to avoid Null Pointer Exception, take a look at StringUtils.
Hope this is helpful. Please feel free to provide your suggestions 🙂

References:

https://www.baeldung.com/string-processing-commons-lang
https://www.codebyamir.com/blog/using-stringutils-from-apache-commons-lang-3