## 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.

Author:
  Matthew Inger

Field Summary
`static int` `REPLACE_ALL` Replace all occurances of the regular expression
`static int` `REPLACE_FIRST` Replace only the first occurance 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
`java.lang.String` `substitute(java.lang.String input, java.lang.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 Detail

### REPLACE_FIRST

    public static final int REPLACE_FIRST

  Replace only the first occurance of the regular expression

  See Also:
    Constant Field Values

### REPLACE_ALL

    public static final int REPLACE_ALL

  Replace all occurances of the regular expression

  See Also:
    Constant Field Values

Method Detail

### substitute

    public java.lang.String substitute(java.lang.String input,
                                       java.lang.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.
    `BuildException`

Copyright © 2000-2003 Apache Software Foundation. All Rights Reserved.