java.util.regex.MatchResult.group() Method

Description

The java.time.MatchResult.group() method returns the input subsequence matched by the previous match.

Declaration

Following is the declaration for java.time.MatchResult.group() method.

String group()

Return Value

The (possibly empty) subsequence matched by the previous match, in string form.

Exceptions

• IllegalStateException - If no match has yet been attempted, or if the previous match operation failed.

Example

The following example shows the usage of java.time.MatchResult.group() method.

package com.tutorialspoint;

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

public class MatchResultDemo {
   private static final String REGEX = "(.*)(\\d+)(.*)";
   private static final String INPUT = "This is a sample Text, 1234, with numbers in between.";

   public static void main(String[] args) {
      // create a pattern
      Pattern pattern = Pattern.compile(REGEX);
      // get a matcher object
      Matcher matcher = pattern.matcher(INPUT); 

      if(matcher.find()) {
         //get the MatchResult Object 
         MatchResult result = matcher.toMatchResult();

         //Prints the input subsequence matched by the previous match.
         System.out.println("First Capturing Group - Match String: "+result.group());     
      }
   }
}

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

First Capturing Group - Match String: This is a sample Text, 1234, with numbers in between.