Matcher useAnchoringBounds(boolean) method in Java with Examples

The useAnchoringBounds(boolean) method of Matcher Class is used to set the anchoring bounds of this matcher. By anchoring bounds, it means that the matcher will be matched for the anchors like ^ and $ for getting a match, if the anchoring bounds are set to true. This method returns a Matcher with the modified anchoring bounds.

Syntax:

public boolean useAnchoringBounds(
               boolean setAnchoringBounds)

Parameters: This method takes a parameter setAnchoringBounds which is a boolean value depicting the anchoring bounds of this matcher to be modified into.

Return Value: This method returns a Matcher with the modified anchoring bounds.

Below examples illustrate the Matcher.useAnchoringBounds() method:

Example 1:

// Java code to illustrate useAnchoringBounds() method

import java.util.regex.*;

public class GFG {
    public static void main(String[] args)
    {

        // Get the regex to be checked
        String regex = "(Geeks)";

        // Create a pattern from regex
        Pattern pattern
            = Pattern.compile(regex);

        // Get the String to be matched
        String stringToBeMatched
            = "GeeksForGeeks Geeks for For Geeks Geek";

        // Create a matcher for the input String
        Matcher matcher
            = pattern.matcher(stringToBeMatched);

        // set the anchoring bounds to true
        // using useAnchoringBounds() method
        matcher = matcher
                      .useAnchoringBounds(true);

        // Check if this matcher has anchoring bounds or not
        System.out.println("Does this matcher"
                           + " has anchoring bounds: "
                           + matcher.hasAnchoringBounds());
    }
}

Output:

Does this matcher has anchoring bounds: true

Example 2:

// Java code to illustrate useAnchoringBounds() method

import java.util.regex.*;

public class GFG {
    public static void main(String[] args)
    {

        // Get the regex to be checked
        String regex = "(FGF)";

        // Create a pattern from regex
        Pattern pattern
            = Pattern.compile(regex);

        // Get the String to be matched
        String stringToBeMatched
            = "FGF GFG GFG FGF";

        // Create a matcher for the input String
        Matcher matcher
            = pattern.matcher(stringToBeMatched);

        // set the anchoring bounds to true
        // using useAnchoringBounds() method
        matcher = matcher
                      .useAnchoringBounds(false);

        // Check if this matcher has anchoring bounds or not
        System.out.println("Does this matcher"
                           + " has anchoring bounds: "
                           + matcher.hasAnchoringBounds());
    }
}

Output:

Does this matcher has anchoring bounds: false

Reference: https://docs.oracle.com/javase/9/docs/api/java/util/regex/Matcher.html#useAnchoringBounds-boolean-