Package net.sf.saxon.regex

## Interface RegexIterator.MatchHandler

- Enclosing interface:
    RegexIterator

      public static interface RegexIterator.MatchHandler

  Interface defining a call-back action for processing captured groups

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `void` | `characters​(java.lang.CharSequence s)` | Method to be called with each fragment of text in a matching substring
    `void` | `onGroupEnd​(int groupNumber)` | Method to be called when the end of a captured group is encountered
    `void` | `onGroupStart​(int groupNumber)` | Method to be called when the start of a captured group is encountered

- - ### Method Detail

    - #### characters

          void characters​(java.lang.CharSequence s)
                   throws XPathException

      Method to be called with each fragment of text in a matching substring
      Parameters:
        `s` - a matching substring, or part thereof that falls within a specific group
      Throws:
        `XPathException`

    - #### onGroupStart

          void onGroupStart​(int groupNumber)
                     throws XPathException

      Method to be called when the start of a captured group is encountered
      Parameters:
        `groupNumber` - the group number of the captured group
      Throws:
        `XPathException`

    - #### onGroupEnd

          void onGroupEnd​(int groupNumber)
                   throws XPathException

      Method to be called when the end of a captured group is encountered
      Parameters:
        `groupNumber` - the group number of the captured group
      Throws:
        `XPathException`