Class ReplaceRegExp
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.optional.ReplaceRegExp
- All Implemented Interfaces:
- Cloneable
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 implementation 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).
 
 Available implementations:
   org.apache.tools.ant.util.regexp.Jdk14RegexpRegexp (default)
        Uses Java's built-in regular expression package
   org.apache.tools.ant.util.regexp.JakartaOroRegexp
        Requires  the jakarta-oro package
   org.apache.tools.ant.util.regexp.JakartaRegexpRegexp
        Requires the jakarta-regexp 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 SummaryFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidSupport arbitrary file system based resource collections.voidaddFileset(FileSet set) list files to apply the replacement toA regular expression.A substitution pattern.protected voidPerform the replacement on a fileprotected StringdoReplace(RegularExpression r, Substitution s, String input, int options) Invoke a regular expression (r) on a string (input) using substitutions (s) for a matching regex.voidexecute()Execute the taskvoidsetByLine(boolean byline) Process the file(s) one line at a time, executing the replacement on one line at a time.voidDeprecated.since 1.6.x.voidsetEncoding(String encoding) Specifies the encoding Ant expects the files to be in - defaults to the platforms default encoding.voidfile for which the regular expression should be replaced; required unless a nested fileset is supplied.voidThe flags to use when matching the regular expression.voidthe regular expression pattern to match in the file(s); required if no nested <regexp> is usedvoidsetPreserveLastModified(boolean b) Whether the file timestamp shall be preserved even if the file is modified.voidsetReplace(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.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskTypeMethods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
- 
Constructor Details- 
ReplaceRegExppublic ReplaceRegExp()Default Constructor
 
- 
- 
Method Details- 
setFilefile for which the regular expression should be replaced; required unless a nested fileset is supplied.- Parameters:
- file- The file for which the reg exp should be replaced.
 
- 
setMatchthe regular expression pattern to match in the file(s); required if no nested <regexp> is used- Parameters:
- match- the match attribute.
 
- 
setReplaceThe substitution pattern to place in the file(s) in place of the regular expression. Required if no nested <substitution> is used- Parameters:
- replace- the replace attribute
 
- 
setFlagsThe flags to use when matching the regular expression. For more information, consult the Perl5 syntax.- g : Global replacement. Replace all occurrences found
- i : Case Insensitive. Do not consider case in the match
- m : Multiline. Treat the string as multiple lines of input, using "^" and "$" as the start or end of any line, respectively, rather than start or end of string.
- s : Singleline. Treat the string as a single line of input, using "." to match any character, including a newline, which normally, it would not match.
 - Parameters:
- flags- the flags attribute
 
- 
setByLineDeprecated.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
 
- 
setByLinepublic void setByLine(boolean byline) 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
 
- 
setEncodingSpecifies the encoding Ant expects the files to be in - defaults to the platforms default encoding.- Parameters:
- encoding- the encoding attribute
- Since:
- Ant 1.6
 
- 
addFilesetlist files to apply the replacement to- Parameters:
- set- the fileset element
 
- 
addConfiguredSupport arbitrary file system based resource collections.- Parameters:
- rc- ResourceCollection
- Since:
- Ant 1.8.0
 
- 
createRegexpA regular expression. You can use this element to refer to a previously defined regular expression datatype instance- Returns:
- the regular expression object to be configured as an element
 
- 
createSubstitutionA substitution pattern. You can use this element to refer to a previously defined substitution pattern datatype instance.- Returns:
- the substitution pattern object to be configured as an element
 
- 
setPreserveLastModifiedpublic void setPreserveLastModified(boolean b) Whether the file timestamp shall be preserved even if the file is modified.- Parameters:
- b- boolean
- Since:
- Ant 1.8.0
 
- 
doReplaceInvoke a regular expression (r) on a string (input) using substitutions (s) for a matching regex.- 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
 
- 
doReplacePerform the replacement on a file- Parameters:
- f- the file to perform the replacement on
- options- the regular expressions options
- Throws:
- IOException- if an error occurs
 
- 
executeExecute the task- Overrides:
- executein class- Task
- Throws:
- BuildException- is there is a problem in the task execution.
 
 
-