java.util.regex.Matcher.requireEnd() Method

Description

The java.util.regex.Matcher.requireEnd() method returns true if more input could change a positive match into a negative one.

Declaration

Following is the declaration for java.util.regex.Matcher.requireEnd() method.

public boolean requireEnd()

Return Value

True if and only if more input could change a positive match into a negative one.

Example

The following example shows the usage of java.util.regex.Matcher.requireEnd() method.

package com.tutorialspoint;

import java.util.regex.Matcher;
import java.util.regex.Pattern;

public class MatcherDemo {
   private static String REGEX = "(a*b)(foo)";
   private static String INPUT = "aabfooaabfooabfoob";
   private static String REPLACE = "-";
   
   public static void main(String[] args) {
      Pattern pattern = Pattern.compile(REGEX);
      
      // get a matcher object
      Matcher matcher = pattern.matcher(INPUT);
      
      while(matcher.find()) {
         //Prints the offset after the last character matched.
         System.out.println("First Capturing Group, (a*b) Match String end(): "+matcher.end());   
         System.out.println("requireEnd(): "+matcher.requireEnd());    
      }     
   }
}

Let us compile and run the above program, this will produce the following result −

First Capturing Group, (a*b) Match String end(): 6
requireEnd(): false
First Capturing Group, (a*b) Match String end(): 12
requireEnd(): false
First Capturing Group, (a*b) Match String end(): 17
requireEnd(): false