org.apache.tools.ant.taskdefs.optional
public class ReplaceRegExp extends Task
ant.regexp.regexpimpl
will be the classname of the implementation that will be used (the default
is org.apache.tools.ant.util.regexp.JakartaOroRegexp
and
requires the Jakarta Oro Package).
For jdk <= 1.3, there are two available implementations: org.apache.tools.ant.util.regexp.JakartaOroRegexp (the default) Requires the jakarta-oro package org.apache.tools.ant.util.regexp.JakartaRegexpRegexp Requires the jakarta-regexp package For jdk >= 1.4 an additional implementation is available: org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp Requires the jdk 1.4 built in regular expression package. Usage: Call Syntax: <replaceregexp file="file" match="pattern" replace="pattern" flags="options"? byline="true|false"? > regexp? substitution? fileset* </replaceregexp> NOTE: You must have either the file attribute specified, or at least one fileset subelement to operation on. You may not have the file attribute specified if you nest fileset elements inside this task. Also, you cannot specify both match and a regular expression subelement at the same time, nor can you specify the replace attribute and the substitution subelement at the same time. Attributes: file --> A single file to operation on (mutually exclusive with the fileset subelements) match --> The Regular expression to match replace --> The Expression replacement string flags --> The options to give to the replacement g = Substitute all occurrences. default is to replace only the first one i = Case insensitive match byline --> Should this file be processed a single line at a time (default is false) "true" indicates to perform replacement on a line by line basis "false" indicates to perform replacement on the whole file at once. Example: The following call could be used to replace an old property name in a ".properties" file with a new name. In the replace attribute, you can refer to any part of the match expression in parenthesis using backslash followed by a number like '\1'. <replaceregexp file="test.properties" match="MyProperty=(.*)" replace="NewProperty=\1" byline="true" />
Constructor Summary | |
---|---|
ReplaceRegExp() Default Constructor |
Method Summary | |
---|---|
void | addFileset(FileSet set)
list files to apply the replacement to |
RegularExpression | createRegexp()
A regular expression.
|
Substitution | createSubstitution()
A substitution pattern. |
protected String | doReplace(RegularExpression r, Substitution s, String input, int options)
Invoke a regular expression (r) on a string (input) using
substitutions (s) for a matching regex.
|
protected void | doReplace(File f, int options)
Perform the replacement on a file
|
void | execute()
Execute the task
|
void | setByLine(String byline)
Process the file(s) one line at a time, executing the replacement
on one line at a time. |
void | setByLine(boolean byline)
Process the file(s) one line at a time, executing the replacement
on one line at a time. |
void | setEncoding(String encoding)
Specifies the encoding Ant expects the files to be in -
defaults to the platforms default encoding. |
void | setFile(File file)
file for which the regular expression should be replaced;
required unless a nested fileset is supplied. |
void | setFlags(String flags)
The flags to use when matching the regular expression. |
void | setMatch(String match)
the regular expression pattern to match in the file(s);
required if no nested <regexp> is used |
void | setReplace(String replace)
The substitution pattern to place in the file(s) in place
of the regular expression.
|
Parameters: set the fileset element
Returns: the regular expression object to be configured as an element
Returns: the substitution pattern object to be configured as an element
Parameters: r a regular expression s a Substitution input the string to do the replacement on options The options for the regular expression
Returns: the replacement result
Parameters: f the file to perform the relacement on options the regular expressions options
Throws: IOException if an error occurs
Throws: BuildException is there is a problem in the task execution.
Deprecated: since 1.6.x. Use setByLine(boolean).
Process the file(s) one line at a time, executing the replacement on one line at a time. This is useful if you want to only replace the first occurrence of a regular expression on each line, which is not easy to do when processing the file as a whole. Defaults to false.Parameters: byline the byline attribute as a string
Parameters: byline the byline attribute
Parameters: encoding the encoding attribute
Since: Ant 1.6
Parameters: file The file for which the reg exp should be replaced.
Parameters: flags the flags attribute
Parameters: match the match attribute.
Parameters: replace the replace attribute