String Handling with Apache Commons' StringUtils Class in Java
Last Updated :
28 Apr, 2025
The Apache Commons Lang library is a popular third-party library for working with Strings in Java, and the StringUtils class is a key part of this library. StringUtils is a utility class that provides a wide range of String manipulation methods that are not available in the standard Java String class.
Key Features of The StringUtils Class
- Null-safe methods: Many of the methods in the StringUtils class are designed to handle null Strings gracefully, rather than throwing NullPointerExceptions. For example, the isBlank() method checks whether a String is null or contains only whitespace characters.
- Methods for manipulating Strings: The StringUtils class provides a range of methods for manipulating Strings, such as trim() to remove leading and trailing whitespace, and substringBefore() and substringAfter() to extract substrings.
- Methods for comparing Strings: The StringUtils class provides methods for comparing Strings, such as equals() and equalsIgnoreCase(), that handle null Strings and avoid NullPointerExceptions.
- Methods for formatting Strings: The StringUtils class provides methods for formatting Strings, such as join() to join an array of Strings into a single String with a separator.
- Methods for handling cases: The StringUtils class provides methods for changing the case of Strings, such as capitalize() to capitalize the first letter of a String, and swapCase() to swap the case of the characters in a String.
- Methods for searching Strings: The StringUtils class provides methods for searching Strings, such as contains() to check whether a String contains a given substring, and indexOf() to find the index of a given substring.
- Methods for manipulating whitespace: The StringUtils class provides methods for manipulating whitespace in Strings, such as normalizeSpace() to convert multiple whitespace characters to a single space, and replaceEach() to replace multiple whitespace characters with a single character.
- Methods for working with characters: The StringUtils class provides methods for working with individual characters in Strings, such as countMatches() to count the number of occurrences of a given character or substring, and remove() to remove a specific character or substring from a String.
- Methods for formatting numbers: The StringUtils class provides methods for formatting numbers as Strings, such as leftPad() and rightPad() to pad a number with leading or trailing zeros or spaces.
- Methods for handling line breaks: The StringUtils class provides methods for handling line breaks in Strings, such as replaceEach() to replace multiple lines breaks with a single line break, and split() to split a String into an array of Strings based on line breaks.
Getting Started with Apache Commons for Maven and Gradle involves the following steps:
For Maven:
Add the Apache Commons Lang dependency to your pom.xml file
XML
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.12.0</version>
</dependency>
Run a Maven build to download the dependency and add it to your project's classpath. Import the StringUtils class in your Java code.
import org.apache.commons.lang3.StringUtils;
Use the StringUtils class in your Java code, as described in the previous answer.
For Gradle:
Add the Apache Commons Lang dependency to your build.gradle file:
dependencies {
implementation 'org.apache.commons:commons-lang3:3.12.0'
}
Run a Gradle build to download the dependency and add it to your project's classpath. Import the StringUtils class in your Java code:
import org.apache.commons.lang3.StringUtils;
Use the StringUtils class in your Java code, as described in the previous answer.
StringUtils Class Available utility Methods
A list of some of the methods available in the StringUtils class of Apache Commons Lang, along with a brief explanation of what each method does:
- isBlank(String str): This method checks if a String is null, empty, or contains only whitespace characters. It returns true if the String is blank, and false otherwise.
- join(Object[] array, String separator): This method joins an array of Objects into a single String, with each element separated by the specified separator. It returns the joined String.
- capitalize(String str): This method capitalizes the first letter of a String and returns the modified String.
- remove(String str, char remove): This method removes all occurrences of a specified character from a String and returns the modified String.
- reverse(String str): This method reverses the order of characters in a String and returns the reversed String.
- substringBefore(String str, String separator): This method returns the substring of a String before the first occurrence of a specified separator. If the separator is not found in the String, the entire String is returned.
- substringAfter(String str, String separator): This method returns the substring of a String after the first occurrence of a specified separator. If the separator is not found in the String, an empty String is returned.
- substringBetween(String str, String open, String close): This method returns the substring of a String between two specified markers. If either marker is not found in the String, null is returned.
- countMatches(String str, String sub): This method counts the number of occurrences of a specified substring within a String and returns the count as an integer.
- isNumeric(String str): This method checks if a String contains only numeric characters (0-9) and optionally a minus sign at the beginning. It returns true if the String is numeric, and false otherwise.
Examples
Below Are the Programs that demonstrate StringUtility class Methods.
Example 1:
Java
import org.apache.commons.lang3.StringUtils;
public class StringUtilsExample {
public static void main(String[] args) {
String str = " hello world ";
// isEmpty() example
boolean empty = StringUtils.isEmpty(str);
System.out.println("Is the string empty? " + empty);
// isBlank() example
boolean blank = StringUtils.isBlank(str);
System.out.println("Is the string blank? " + blank);
// trim() example
String trimmed = StringUtils.trim(str);
System.out.println("The trimmed string is: " + trimmed);
// substring() example
String substring = StringUtils.substring(str, 2, 7);
System.out.println("The substring is: " + substring);
// replace() example
String replaced = StringUtils.replace(str, "world", "Java");
System.out.println("The replaced string is: " + replaced);
// split() example
String[] words = StringUtils.split(str);
System.out.println("The words in the string are:");
for (String word : words) {
System.out.println(word);
}
// join() example
String[] fruits = {"apple", "banana", "orange"};
String joined = StringUtils.join(fruits, ", ");
System.out.println("The joined string is: " + joined);
// capitalize() example
String capitalized = StringUtils.capitalize(str);
System.out.println("The capitalized string is: " + capitalized);
// equalsIgnoreCase() example
boolean equal = StringUtils.equalsIgnoreCase(str, " Hello World ");
System.out.println("Are the strings equal? " + equal);
}
}
Output:
Is the string empty? false
Is the string blank? false
The trimmed string is: hello world
The substring is: llo w
The replaced string is: hello Java
The words in the string are:
hello
world
The joined string is: apple, banana, orange
The capitalized string is: Hello world
Are the strings equal? true
Note: You'll need to have the Apache Commons Lang library added to your project's classpath in order for this program to compile and run successfully.
Example 2:
Java
import org.apache.commons.lang3.StringUtils;
public class StringUtilsExample {
public static void main(String[] args) {
String str1 = "Hello";
String str2 = "World";
// concatenate two strings
String result1 = StringUtils.join(new String[]{str1, str2}, " ");
System.out.println("Result 1: " + result1);
// repeat a string
String result2 = StringUtils.repeat(str1, 3);
System.out.println("Result 2: " + result2);
// capitalize first letter
String result3 = StringUtils.capitalize(str1);
System.out.println("Result 3: " + result3);
// swap case
String result4 = StringUtils.swapCase(str2);
System.out.println("Result 4: " + result4);
// count matches
int result5 = StringUtils.countMatches(result1, "l");
System.out.println("Result 5: " + result5);
}
}
Output:
Result 1: Hello World
Result 2: HelloHelloHello
Result 3: Hello
Result 4: wORLD
Result 5: 3
Explanation:
- isNullOrEmpty(String str) - This method takes a string as input and checks if the string is null or empty. If the string is null or empty, it returns true, otherwise, it returns false.
- reverse(String str) - This method takes a string as input and reverses the string. It uses a StringBuilder to append each character of the string in reverse order. It then returns the reversed string.
- countOccurrences(String str, String sub) - This method takes two strings as input - a string and a substring. It then counts the number of occurrences of the substring in the string and returns the count.
- All the methods are static, so they can be accessed without creating an object of the StringUtils class. The methods are useful in different scenarios such as checking if a string is empty, reversing a string, or counting the number of occurrences of a substring in a string.
Note: You'll need to have the Apache Commons Lang library added to your project's classpath in order for this program to compile and run successfully.
Some Additional Insights on StringUtils class in Java
- The StringUtils class provides a number of convenient methods for working with Strings, which can save you time and simplify your code. For example, instead of writing your own method to check if a String is empty or null, you can use the isEmpty() method from the StringUtils class.
- Many of the methods in the StringUtils class have equivalent methods in the standard String class in Java. However, the StringUtils versions often have additional functionality, such as handling null inputs gracefully or ignoring cases when comparing strings.
- The StringUtils class is part of the Apache Commons Lang library, which provides many other useful utility classes for working with Java code. If you find yourself using the StringUtils class frequently, you might want to explore some of the other classes in this library to see if they can help you simplify your code further.
- When using the StringUtils class, be aware that some of the methods can throw a NullPointerException if you pass in a null value. To avoid this, you can either check for null inputs explicitly before calling a StringUtils method or use the StringUtils.defaultString() method to convert null inputs to empty strings.
- When using the split() method in the StringUtils class, be aware that it uses whitespace as the default delimiter if no delimiter is specified. If you want to split on a different character or sequence of characters, you'll need to pass that in as a parameter to the split() method.
Overall, the StringUtils class is a powerful and convenient tool for working with Strings in Java. By learning about the different methods it provides and how to use them effectively, you can simplify your code and save time in your Java programming projects.
Similar Reads
Java Tutorial Java is a high-level, object-oriented programming language used to build web apps, mobile applications, and enterprise software systems. It is known for its Write Once, Run Anywhere capability, which means code written in Java can run on any device that supports the Java Virtual Machine (JVM).Java s
10 min read
Basics
Introduction to JavaJava is a high-level, object-oriented programming language developed by Sun Microsystems in 1995. It is platform-independent, which means we can write code once and run it anywhere using the Java Virtual Machine (JVM). Java is mostly used for building desktop applications, web applications, Android
4 min read
Java Programming BasicsJava is one of the most popular and widely used programming language and platform. A platform is an environment that helps to develop and run programs written in any programming language. Java is fast, reliable and secure. From desktop to web applications, scientific supercomputers to gaming console
4 min read
Java MethodsJava Methods are blocks of code that perform a specific task. A method allows us to reuse code, improving both efficiency and organization. All methods in Java must belong to a class. Methods are similar to functions and expose the behavior of objects.Example: Java program to demonstrate how to crea
7 min read
Access Modifiers in JavaIn Java, access modifiers are essential tools that define how the members of a class, like variables, methods, and even the class itself, can be accessed from other parts of our program. They are an important part of building secure and modular code when designing large applications. In this article
6 min read
Arrays in JavaIn Java, an array is an important linear data structure that allows us to store multiple values of the same type. Arrays in Java are objects, like all other objects in Java, arrays implicitly inherit from the java.lang.Object class. This allows you to invoke methods defined in Object (such as toStri
9 min read
Java StringsIn Java, a String is the type of object that can store a sequence of characters enclosed by double quotes and every character is stored in 16 bits, i.e., using UTF 16-bit encoding. A string acts the same as an array of characters. Java provides a robust and flexible API for handling strings, allowin
8 min read
Regular Expressions in JavaIn Java, Regular Expressions or Regex (in short) in Java is an API for defining String patterns that can be used for searching, manipulating, and editing a string in Java. Email validation and passwords are a few areas of strings where Regex is widely used to define the constraints. Regular Expressi
7 min read
OOPs & Interfaces
Classes and Objects in JavaIn Java, classes and objects are basic concepts of Object Oriented Programming (OOPs) that are used to represent real-world concepts and entities. A class is a template to create objects having similar properties and behavior, or in other words, we can say that a class is a blueprint for objects.An
10 min read
Java ConstructorsIn Java, constructors play an important role in object creation. A constructor is a special block of code that is called when an object is created. Its main job is to initialize the object, to set up its internal state, or to assign default values to its attributes. This process happens automaticall
10 min read
Java OOP(Object Oriented Programming) ConceptsBefore Object-Oriented Programming (OOPs), most programs used a procedural approach, where the focus was on writing step-by-step functions. This made it harder to manage and reuse code in large applications.To overcome these limitations, Object-Oriented Programming was introduced. Java is built arou
10 min read
Java PackagesPackages in Java are a mechanism that encapsulates a group of classes, sub-packages, and interfaces. Packages are used for: Prevent naming conflicts by allowing classes with the same name to exist in different packages, like college.staff.cse.Employee and college.staff.ee.Employee.They make it easie
8 min read
Java InterfaceAn Interface in Java programming language is defined as an abstract type used to specify the behaviour of a class. An interface in Java is a blueprint of a behaviour. A Java interface contains static constants and abstract methods. Key Properties of Interface:The interface in Java is a mechanism to
11 min read
Collections
Exception Handling
Java Exception HandlingException handling in Java is an effective mechanism for managing runtime errors to ensure the application's regular flow is maintained. Some Common examples of exceptions include ClassNotFoundException, IOException, SQLException, RemoteException, etc. By handling these exceptions, Java enables deve
8 min read
Java Try Catch BlockA try-catch block in Java is a mechanism to handle exceptions. This make sure that the application continues to run even if an error occurs. The code inside the try block is executed, and if any exception occurs, it is then caught by the catch block.Example: Here, we are going to handle the Arithmet
4 min read
Java final, finally and finalizeIn Java, the final, finally, and finalize keywords play an important role in exception handling. The main difference between final, finally, and finalize is listed below:final: The final is the keyword that can be used for immutability and restrictions in variables, methods, and classes.finally: The
4 min read
Chained Exceptions in JavaChained Exceptions in Java allow associating one exception with another, i.e. one exception describes the cause of another exception. For example, consider a situation in which a method throws an ArithmeticException because of an attempt to divide by zero.But the root cause of the error was an I/O f
3 min read
Null Pointer Exception in JavaA NullPointerException in Java is a RuntimeException. It occurs when a program attempts to use an object reference that has the null value. In Java, "null" is a special value that can be assigned to object references to indicate the absence of a value.Reasons for Null Pointer ExceptionA NullPointerE
5 min read
Exception Handling with Method Overriding in JavaIn Java, an exception is an unwanted or unexpected event that occurs during a program's execution, i.e., at runtime, and disrupts the normal flow of the programâs instructions. Exception handling in Java handles runtime errors and helps maintain the program's normal flow by using constructs like try
5 min read
Java Advanced
Java Multithreading TutorialThreads are the backbone of multithreading. We are living in the real world which in itself is caught on the web surrounded by lots of applications. With the advancement in technologies, we cannot achieve the speed required to run them simultaneously unless we introduce the concept of multi-tasking
15+ min read
Synchronization in JavaIn multithreading, synchronization is important to make sure multiple threads safely work on shared resources. Without synchronization, data can become inconsistent or corrupted if multiple threads access and modify shared variables at the same time. In Java, it is a mechanism that ensures that only
10 min read
File Handling in JavaIn Java, with the help of File Class, we can work with files. This File Class is inside the java.io package. The File class can be used to create an object of the class and then specifying the name of the file.Why File Handling is Required?File Handling is an integral part of any programming languag
6 min read
Java Method ReferencesIn Java, a method is a collection of statements that perform some specific task and return the result to the caller. A method reference is the shorthand syntax for a lambda expression that contains just one method call. In general, one does not have to pass arguments to method references.Why Use Met
9 min read
Java 8 Stream TutorialJava 8 introduces Stream, which is a new abstract layer, and some new additional packages in Java 8 called java.util.stream. A Stream is a sequence of components that can be processed sequentially. These packages include classes, interfaces, and enum to allow functional-style operations on the eleme
15+ min read
Java NetworkingWhen computing devices such as laptops, desktops, servers, smartphones, and tablets and an eternally-expanding arrangement of IoT gadgets such as cameras, door locks, doorbells, refrigerators, audio/visual systems, thermostats, and various sensors are sharing information and data with each other is
15+ min read
JDBC TutorialJDBC stands for Java Database Connectivity. JDBC is a Java API or tool used in Java applications to interact with the database. It is a specification from Sun Microsystems that provides APIs for Java applications to communicate with different databases. Interfaces and Classes for JDBC API comes unde
12 min read
Java Memory ManagementJava memory management is a fundamental concept that involves the automatic allocation and deallocation of objects, managed by the Java Virtual Machine (JVM). The JVM uses a garbage collector to automatically remove unused objects, freeing up memory in the background. This eliminates the need for de
5 min read
Garbage Collection in JavaGarbage collection in Java is an automatic memory management process that helps Java programs run efficiently. Java programs compile to bytecode that can be run on a Java Virtual Machine (JVM). When Java programs run on the JVM, objects in the heap are created, which is a portion of memory dedicated
7 min read
Memory Leaks in JavaIn programming, a memory leak happens when a program keeps using memory but does not give it back when it's done. It simply means the program slowly uses more and more memory, which can make things slow and even stop working. Working of Memory Management in JavaJava has automatic garbage collection,
3 min read
Practice Java
Java Interview Questions and AnswersJava is one of the most popular programming languages in the world, known for its versatility, portability, and wide range of applications. Java is the most used language in top companies such as Uber, Airbnb, Google, Netflix, Instagram, Spotify, Amazon, and many more because of its features and per
15+ min read
Java Programs - Java Programming ExamplesIn this article, we will learn and prepare for Interviews using Java Programming Examples. From basic Java programs like the Fibonacci series, Prime numbers, Factorial numbers, and Palindrome numbers to advanced Java programs.Java is one of the most popular programming languages today because of its
8 min read
Java Exercises - Basic to Advanced Java Practice Programs with SolutionsLooking for Java exercises to test your Java skills, then explore our topic-wise Java practice exercises? Here you will get 25 plus practice problems that help to upscale your Java skills. As we know Java is one of the most popular languages because of its robust and secure nature. But, programmers
7 min read
Java Quiz | Level Up Your Java SkillsThe best way to scale up your coding skills is by practicing the exercise. And if you are a Java programmer looking to test your Java skills and knowledge? Then, this Java quiz is designed to challenge your understanding of Java programming concepts and assess your excellence in the language. In thi
1 min read
Top 50 Java Project Ideas For Beginners and Advanced [Update 2025]Java is one of the most popular and versatile programming languages, known for its reliability, security, and platform independence. Developed by James Gosling in 1982, Java is widely used across industries like big data, mobile development, finance, and e-commerce.Building Java projects is an excel
15+ min read