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 final int`
`MATCH_CASE_INSENSITIVE`
Perform a case insensitive match
`static final int`
`MATCH_DEFAULT`
Default Mask (case insensitive, neither multiline nor singleline specified).
`static final int`
`MATCH_MULTILINE`
Treat the input as a multiline input
`static final int`
`MATCH_SINGLELINE`
Treat the input as singleline input ('.' matches newline)

## Method Summary

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

## Field Details

### MATCH_DEFAULT

static final int MATCH_DEFAULT
Default Mask (case insensitive, neither multiline nor singleline specified).

See Also:
  - Constant Field Values

### MATCH_CASE_INSENSITIVE

static final int MATCH_CASE_INSENSITIVE
Perform a case insensitive match

See Also:
  - Constant Field Values

### MATCH_MULTILINE

static final int MATCH_MULTILINE
Treat the input as a multiline input

See Also:
  - Constant Field Values

### MATCH_SINGLELINE

static final int MATCH_SINGLELINE
Treat the input as singleline input ('.' matches newline)

See Also:
  - Constant Field Values

## Method Details

### setPattern

void setPattern(String pattern) throws BuildException
Set the regexp pattern from the String description.

Parameters:
  `pattern` - the pattern to match
Throws:
  `BuildException` - on error

### getPattern

String getPattern() throws BuildException
Get a String representation of the regexp pattern

Returns:
  the pattern
Throws:
  `BuildException` - on error

### matches

boolean matches(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

Vector<String> getGroups(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(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

Vector<String> getGroups(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