Controlling Regex with Flags

Introduction

Welcome back to Regex Validation, Flags, and Text Processing in Java! You've reached the second lesson, and you're building impressive momentum. In the previous lesson, you mastered full-string validation using Pattern.matches(), creating username and password validators that enforce complete input requirements. You learned to distinguish validation from pattern searching, ensuring that every character from start to finish follows your rules. These validators work well for straightforward requirements, but real-world text processing often demands more flexibility. Consider these common scenarios: searching for keywords regardless of whether they're capitalized, writing complex patterns that need comments for maintainability, matching patterns at the start of every line in a multi-line document, or capturing text that spans multiple lines. Your current regex knowledge handles the patterns themselves beautifully, but these situations require control over how the regex engine interprets those patterns . This lesson introduces flags : special options that modify regex behavior without changing the pattern itself. You'll learn to make matches case-insensitive, write readable verbose patterns, handle line boundaries properly, and match across newlines. Let's explore how flags give you powerful control over pattern-matching behavior.

Understanding Regular Expression Flags

Flags are optional parameters that change how the regex engine processes your pattern. Without flags, the engine follows default behavior: matches are case-sensitive, the dot metacharacter doesn't match newlines, anchors like^and $ only match the very start and end of the string, and patterns must be written compactly on single lines. These defaults work fine for many cases, but they can become limiting when your requirements differ. Think about searching for a product name in customer reviews. If you search for "iPhone" but reviews contain "iphone," "IPHONE," or "IPhone," you'll miss relevant matches without case-insensitive matching. Or imagine validating a URL with a complex pattern: without flags, you'd need to write it as one long, hard-to-read line with no comments. Flags solve these problems by letting you tell the regex engine: "treat uppercase and lowercase as equivalent," or "let me split this pattern across multiple lines with explanatory comments." Java's Pattern class provides several flags that we'll explore throughout this lesson, each addressing specific pattern-matching challenges.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal

Matching Across Lines with Pattern.DOTALL

The dot metacharacter . normally matches any character except the newline \n. This default behavior works well when you're searching within single lines, but it becomes a problem when patterns need to span multiple lines. The Pattern.DOTALL flag (also written as Pattern.S) changes the dot to match any character, including newlines, allowing your patterns to capture text that crosses line boundaries.

Java

String ds = "A\nB";
Pattern p3 = Pattern.compile("A.*B");
Matcher m3 = p3.matcher(ds);
List<String> matches3 = new ArrayList<>();
while (m3.find()) {
    matches3.add(m3.group());
}
System.out.println(matches3);

Pattern p4 = Pattern.compile("A.*B", Pattern.DOTALL);
Matcher m4 = p4.matcher(ds);
List<String> matches4 = new ArrayList<>();
while (m4.find()) {
    matches4.add(m4.group());
}
System.out.println(matches4);

String ds = "A\nB";
Pattern p3 = Pattern.compile("A.*B");
Matcher m3 = p3.matcher(ds);
List<String> matches3 = new ArrayList<>();
while (m3.find()) {
    matches3.add(m3.group());
}
System.out.println(matches3);

Pattern p4 = Pattern.compile("A.*B", Pattern.DOTALL);
Matcher m4 = p4.matcher(ds);
List<String> matches4 = new ArrayList<>();
while (m4.find()) {
    matches4.add(m4.group());
}
System.out.println(matches4);

The string ds is "A\nB": the letter A, a newline character, and the letter B on the next line. The pattern "A.*B" tries to match A, followed by any characters, followed by B. Without Pattern.DOTALL, the .* can't match the newline, so the pattern fails. With Pattern.DOTALL, the .* matches the newline, allowing the pattern to span both lines.

text

[]
[A
B]

[]
[A
B]

The first search without the flag returns an empty list [] because . stops at the newline and can't connect A to B. The second with Pattern.DOTALL returns [A\nB]: a successful match that captured the A, the newline, and the B. This flag is essential when extracting multi-line content like code blocks from markdown, capturing paragraphs that span lines, or matching HTML elements that contain newlines. Without it, your patterns would fail whenever they need to cross line boundaries.

Combining Multiple Flags

Java allows you to combine multiple flags when you need several behaviors simultaneously. You use the bitwise OR operator | to join flags together. This is the most common way to apply multiple settings during pattern compilation.

For example, if you wanted case-insensitive matching in verbose mode, you could write Pattern.compile(pattern, Pattern.CASE_INSENSITIVE | Pattern.COMMENTS). This gives you the benefits of both flags at once: readable patterns with comments and case-insensitive matching.

Java

// Example combining flags using Pattern constants
String pattern = "hello " +      // match hello
                "\\s+ " +        // followed by whitespace
                "world ";        // and world

Pattern p = Pattern.compile(pattern, Pattern.CASE_INSENSITIVE | Pattern.COMMENTS);
Matcher m = p.matcher("HELLO   WORLD");
System.out.println(m.find());

// Example combining flags using Pattern constants
String pattern = "hello " +      // match hello
                "\\s+ " +        // followed by whitespace
                "world ";        // and world

Pattern p = Pattern.compile(pattern, Pattern.CASE_INSENSITIVE | Pattern.COMMENTS);
Matcher m = p.matcher("HELLO   WORLD");
System.out.println(m.find());

This pattern uses Pattern.COMMENTS for readability (ignoring the spaces and comments in the string) and Pattern.CASE_INSENSITIVE to match "HELLO WORLD" even though the pattern is written in lowercase.

While you can also use "inline flags" like (?ix) inside the string itself, using the Pattern constants with the | operator is generally preferred in Java code because it keeps the configuration logic in the Java code rather than hiding it inside the regex string.

text

true

true

The match succeeds because both flags work together. You can combine any flags you need this way, giving you complete control over how the regex engine processes your patterns. Common combinations include Pattern.MULTILINE | Pattern.DOTALL for processing multi-line documents where patterns need to span lines and respect line boundaries, or Pattern.COMMENTS | Pattern.CASE_INSENSITIVE for readable patterns that match text flexibly.

Introduction

Understanding Regular Expression Flags

Join the 1M+ learners on CodeSignal

Making Complex Patterns Readable with Pattern.COMMENTS

Testing URL Validation with Verbose Patterns

Case-Insensitive Matching with Pattern.CASE_INSENSITIVE

Testing Case-Insensitive Search

Matching Line Boundaries with Pattern.MULTILINE

Matching Across Lines with Pattern.DOTALL

Combining Multiple Flags

Conclusion and Next Steps