ReplaceRegExp (Apache Ant API)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.ProjectComponent | +--org.apache.tools.ant.Task | +--org.apache.tools.ant.taskdefs.optional.ReplaceRegExp
Performs regular expression string replacements in a text
file. The input file(s) must be able to be properly processed by
a Reader instance. That is, they must be text only, no binary.
The syntax of the regular expression depends on the implemtation that
you choose to use. The system property 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" />
Field Summary |
Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
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 void |
doReplace(java.io.File f,
int options)
Perform the replace on the entire file |
protected java.lang.String |
doReplace(RegularExpression r,
Substitution s,
java.lang.String input,
int options)
|
void |
execute()
Called by the project to let the task do its work. |
void |
setByLine(java.lang.String byline)
Process the file(s) one line at a time, executing the replacement on one line at a time. |
void |
setFile(java.io.File file)
file for which the regular expression should be replaced; required unless a nested fileset is supplied. |
void |
setFlags(java.lang.String flags)
The flags to use when matching the regular expression. |
void |
setMatch(java.lang.String match)
the regular expression pattern to match in the file(s); required if no nested <regexp> is used |
void |
setReplace(java.lang.String replace)
The substitution pattern to place in the file(s) in place of the regular expression. |
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public ReplaceRegExp()
Method Detail |
public void setFile(java.io.File file)
public void setMatch(java.lang.String match)
public void setReplace(java.lang.String replace)
public void setFlags(java.lang.String flags)
public void setByLine(java.lang.String byline)
public void addFileset(FileSet set)
public RegularExpression createRegexp()
public Substitution createSubstitution()
protected java.lang.String doReplace(RegularExpression r, Substitution s, java.lang.String input, int options)
protected void doReplace(java.io.File f, int options) throws java.io.IOException
java.io.IOException
public void execute() throws BuildException
Task
execute
in class Task
BuildException
- if something goes wrong with the build
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |