Interface TMatchResult

All Known Implementing Classes:
TMatcher

public interface TMatchResult
Holds the results of a successful match of a TPattern against a given string. The result is divided into groups, with one group for each pair of parentheses in the regular expression and an additional group for the whole regular expression. The start, end, and contents of each group can be queried.
See Also:
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    end()
    Returns the index of the first character following the text that matched the whole regular expression.
    int
    end(int group)
    Returns the index of the first character following the text that matched a given group.
    default int
    end(String name)
     
    Returns the text that matched the whole regular expression.
    group(int group)
    Returns the text that matched a given group of the regular expression.
    default String
    group(String name)
     
    int
    Returns the number of groups in the result, which is always equal to the number of groups in the original regular expression.
     
    int
    Returns the index of the first character of the text that matched the whole regular expression.
    int
    start(int group)
    Returns the index of the first character of the text that matched a given group.
    default int
    start(String name)
     
  • Method Details

    • end

      int end()
      Returns the index of the first character following the text that matched the whole regular expression.
      Returns:
      the character index.
    • end

      int end(int group)
      Returns the index of the first character following the text that matched a given group.
      Parameters:
      group - the group, ranging from 0 to groupCount() - 1, with 0 representing the whole pattern.
      Returns:
      the character index.
    • end

      default int end(String name)
    • group

      String group()
      Returns the text that matched the whole regular expression.
      Returns:
      the text.
    • group

      String group(int group)
      Returns the text that matched a given group of the regular expression.
      Parameters:
      group - the group, ranging from 0 to groupCount() - 1, with 0 representing the whole pattern.
      Returns:
      the text that matched the group.
    • group

      default String group(String name)
    • groupCount

      int groupCount()
      Returns the number of groups in the result, which is always equal to the number of groups in the original regular expression.
      Returns:
      the number of groups.
    • start

      int start()
      Returns the index of the first character of the text that matched the whole regular expression.
      Returns:
      the character index.
    • start

      int start(int group)
      Returns the index of the first character of the text that matched a given group.
      Parameters:
      group - the group, ranging from 0 to groupCount() - 1, with 0 representing the whole pattern.
      Returns:
      the character index.
    • start

      default int start(String name)
    • namedGroups

      Map<String,Integer> namedGroups()