Package org.apache.tools.ant.util.regexp

Interface RegexpMatcher

All Known Subinterfaces:
Regexp
All Known Implementing Classes:
JakartaOroMatcher, JakartaOroRegexp, JakartaRegexpMatcher, JakartaRegexpRegexp, Jdk14RegexpMatcher, Jdk14RegexpRegexp
public interface RegexpMatcher
Interface describing a regular expression matcher.

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static int MATCH_CASE_INSENSITIVE
    Perform a case insensitive match
    static int MATCH_DEFAULT
    Default Mask (case insensitive, neither multiline nor singleline specified).
    static int MATCH_MULTILINE
    Treat the input as a multiline input
    static int MATCH_SINGLELINE
    Treat the input as singleline input ('.' matches newline)

  • Method Summary

    Modifier and Type Method Description
    java.util.Vector<java.lang.String> getGroups​(java.lang.String argument)
    Returns a Vector of matched groups found in the argument using default options.
    java.util.Vector<java.lang.String> getGroups​(java.lang.String input, int options)
    Get the match groups from this regular expression.
    java.lang.String getPattern()
    Get a String representation of the regexp pattern
    boolean matches​(java.lang.String argument)
    Does the given argument match the pattern?
    boolean matches​(java.lang.String input, int options)
    Does this regular expression match the input, given certain options
    void setPattern​(java.lang.String pattern)
    Set the regexp pattern from the String description.

  • Field Details

  • Method Details

    • setPattern

      void setPattern​(java.lang.String pattern) throws BuildException
      Set the regexp pattern from the String description.
      Parameters:
      pattern - the pattern to match
      Throws:
      BuildException - on error

    • getPattern

      java.lang.String getPattern() throws BuildException
      Get a String representation of the regexp pattern
      Returns:
      the pattern
      Throws:
      BuildException - on error

    • matches

      boolean matches​(java.lang.String argument) throws BuildException
      Does the given argument match the pattern?
      Parameters:
      argument - the string to match against
      Returns:
      true if the pattern matches
      Throws:
      BuildException - on error

    • getGroups

      java.util.Vector<java.lang.String> getGroups​(java.lang.String argument) throws BuildException
      Returns a Vector of matched groups found in the argument using default options.

      Group 0 will be the full match, the rest are the parenthesized subexpressions

      .
      Parameters:
      argument - the string to match against
      Returns:
      the vector of groups
      Throws:
      BuildException - on error

    • matches

      boolean matches​(java.lang.String input, int options) throws BuildException
      Does this regular expression match the input, given certain options
      Parameters:
      input - The string to check for a match
      options - The list of options for the match. See the MATCH_ constants above.
      Returns:
      true if the pattern matches
      Throws:
      BuildException - on error

    • getGroups

      java.util.Vector<java.lang.String> getGroups​(java.lang.String input, int options) throws BuildException
      Get the match groups from this regular expression. The return type of the elements is always String.
      Parameters:
      input - The string to check for a match
      options - The list of options for the match. See the MATCH_ constants above.
      Returns:
      the vector of groups
      Throws:
      BuildException - on error