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

# Interface Regexp

All Superinterfaces:
  `RegexpMatcher`

All Known Implementing Classes:
  `JakartaOroRegexp`, `JakartaRegexpRegexp`, `Jdk14RegexpRegexp`

public interface Regexp extends RegexpMatcher
Interface which represents a regular expression, and the operations that can be performed on it.

## Field Summary

Fields
Modifier and Type
Field
Description
`static final int`
`REPLACE_ALL`
Replace all occurrences of the regular expression
`static final int`
`REPLACE_FIRST`
Replace only the first occurrence of the regular expression

### Fields inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher

`MATCH_CASE_INSENSITIVE, MATCH_DEFAULT, MATCH_MULTILINE, MATCH_SINGLELINE`

## Method Summary

Modifier and Type
Method
Description
`String`
`substitute(String input, String argument, int options)`
Perform a substitution on the regular expression.

### Methods inherited from interface org.apache.tools.ant.util.regexp.RegexpMatcher

`getGroups, getGroups, getPattern, matches, matches, setPattern`

## Field Details

### REPLACE_FIRST

static final int REPLACE_FIRST
Replace only the first occurrence of the regular expression

See Also:
  - Constant Field Values

### REPLACE_ALL

static final int REPLACE_ALL
Replace all occurrences of the regular expression

See Also:
  - Constant Field Values

## Method Details

### substitute

String substitute(String input, String argument, int options) throws BuildException
Perform a substitution on the regular expression.

Parameters:
  `input` - The string to substitute on
  `argument` - The string which defines the substitution
  `options` - The list of options for the match and replace. See the MATCH_ and REPLACE_ constants above.
Returns:
  the result of the operation
Throws:
  `BuildException` - on error