Java CharSequence stripIndent()

In this guide, you will learn about the CharSequence stripIndent() method in Java programming and how to use it with an example.

1. CharSequence stripIndent() Method Overview

Definition:

The stripIndent() method is a part of the CharSequence interface in Java, introduced in Java 12. This method removes incidental white space characters from the beginning and end of each line in a multi-line string and adjusts the indentation of each line to the smallest indentation of any line.

Syntax:

default CharSequence stripIndent()

Parameters:

The method does not take any parameters.

Key Points:

- Introduced in Java 12 as a part of JEP 355.

- Useful for adjusting the indentation of multi-line strings.

- It strips leading and trailing white spaces and adjusts indentation.

- This method is particularly beneficial when working with text blocks, which were also introduced in Java 12.

2. CharSequence stripIndent() Method Example

public class StripIndentExample {
    public static void main(String[] args) {
        String multiLineString = """
                This is an example
                    of a multi-line
                string with
                    inconsistent
                indentation.""";

        // Applying stripIndent to the multi-line string
        CharSequence result = multiLineString.stripIndent();

        // Printing the result
        System.out.println(result);
    }
}

Output:

This is an example
    of a multi-line
string with
    inconsistent
indentation.

Explanation:

In this example, a multi-line string with inconsistent indentation is defined. By calling the stripIndent() method on this string, the incidental white spaces are removed, and the indentation of each line is adjusted to the smallest indentation of any line. The resulting output shows a more consistent and cleaned-up indentation of the multi-line string.