Matcher hitEnd() method in Java with Examples

The hitEnd() method of Matcher Class is used to check if this the matching of the pattern on this matcher has stopped or not. The matching ends when no more matched group is found in the matcher. This method returns a boolean value stating the same.

Syntax:

public boolean hitEnd()

Parameters: This method takes no parameters.



Return Value: This method returns a boolean value stating whether this matcher has finished matching or not.

Below examples illustrate the Matcher.hitEnd() method:

Example 1:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java code to illustrate hitEnd() 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);
  
        while (matcher.find()) {
  
            System.out.println("Group matched: "
                               + matcher.group());
  
            // Check if the matching has ended
            // using hitEnd() method
            System.out.println("Has matching hit end: "
                               + matcher.hitEnd());
        }
  
        // Check if the matching has ended
        // using hitEnd() method
        System.out.println("Has matching hit end: "
                           + matcher.hitEnd());
    }
}

chevron_right


Output:

Group matched: Geeks
Has matching hit end: false
Group matched: Geeks
Has matching hit end: false
Group matched: Geeks
Has matching hit end: false
Group matched: Geeks
Has matching hit end: false
Has matching hit end: true

Example 2:

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java code to illustrate hitEnd() method
  
import java.util.regex.*;
  
public class GFG {
    public static void main(String[] args)
    {
  
        // Get the regex to be checked
        String regex = "(GFG)";
  
        // Create a pattern from regex
        Pattern pattern
            = Pattern.compile(regex);
  
        // Get the String to be matched
        String stringToBeMatched
            = "GFGFGFGFGFGFGFGFGFG FGF GFG GFG FGF";
  
        // Create a matcher for the input String
        Matcher matcher
            = pattern.matcher(stringToBeMatched);
  
        while (matcher.find()) {
  
            System.out.println("Group matched: "
                               + matcher.group());
  
            // Check if the matching has ended
            // using hitEnd() method
            System.out.println("Has matching hit end: "
                               + matcher.hitEnd());
        }
  
        // Check if the matching has ended
        // using hitEnd() method
        System.out.println("Has matching hit end: "
                           + matcher.hitEnd());
    }
}

chevron_right


Output:

Group matched: GFG
Has matching hit end: false
Group matched: GFG
Has matching hit end: false
Group matched: GFG
Has matching hit end: false
Group matched: GFG
Has matching hit end: false
Group matched: GFG
Has matching hit end: false
Group matched: GFG
Has matching hit end: false
Group matched: GFG
Has matching hit end: false
Has matching hit end: true

Reference: https://docs.oracle.com/javase/9/docs/api/java/util/regex/Matcher.html#hitEnd–



My Personal Notes arrow_drop_up

Check out this Author's contributed articles.

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.