net.sf.saxon.regex.RegexMatchHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation

The XSLT and XQuery Processor

There is a newer version: 12.5

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2022 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

package net.sf.saxon.regex;

import net.sf.saxon.str.UnicodeString;
import net.sf.saxon.trans.XPathException;

/**
 * Interface defining a call-back action for processing captured groups within a regular expression
 */

public interface RegexMatchHandler {

    /**
     * Method to be called with each fragment of text in a matching substring
     *
     * @param s a matching substring, or part thereof that falls within a specific group
     */

    void characters(UnicodeString s) throws XPathException;

    /**
     * Method to be called when the start of a captured group is encountered
     *
     * @param groupNumber the group number of the captured group
     */

    void onGroupStart(int groupNumber) throws XPathException;

    /**
     * Method to be called when the end of a captured group is encountered
     *
     * @param groupNumber the group number of the captured group
     */

    void onGroupEnd(int groupNumber) throws XPathException;
}