org.apache.tools.ant.taskdefs

Class Patch

public class Patch extends Task

Patches a file by applying a 'diff' file to it; requires "patch" to be on the execution path.

Since: Ant 1.1

UNKNOWN: category="utility"

Method Summary
voidexecute()
execute patch
voidsetBackups(boolean backups)
flag to create backups; optional, default=false
voidsetDestfile(File file)
The name of a file to send the output to, instead of patching the file(s) in place; optional.
voidsetDir(File directory)
The directory to run the patch command in, defaults to the project's base directory.
voidsetFailOnError(boolean value)
If true, stop the build process if the patch command exits with an error status.
voidsetIgnorewhitespace(boolean ignore)
flag to ignore whitespace differences; default=false
voidsetOriginalfile(File file)
The file to patch; optional if it can be inferred from the diff file
voidsetPatchfile(File file)
The file containing the diff output; required.
voidsetQuiet(boolean q)
Work silently unless an error occurs; optional, default=false
voidsetReverse(boolean r)
Assume patch was created with old and new files swapped; optional, default=false
voidsetStrip(int num)
Strip the smallest prefix containing num leading slashes from filenames.

Method Detail

execute

public void execute()
execute patch

Throws: BuildException when it all goes a bit pear shaped

setBackups

public void setBackups(boolean backups)
flag to create backups; optional, default=false

Parameters: backups if true create backups

setDestfile

public void setDestfile(File file)
The name of a file to send the output to, instead of patching the file(s) in place; optional.

Parameters: file the file to send the output to

Since: Ant 1.6

setDir

public void setDir(File directory)
The directory to run the patch command in, defaults to the project's base directory.

Parameters: directory the directory to run the patch command in

Since: Ant 1.5

setFailOnError

public void setFailOnError(boolean value)
If true, stop the build process if the patch command exits with an error status.

Parameters: value true if it should halt, otherwise false. The default is false.

Since: Ant 1.8.0

setIgnorewhitespace

public void setIgnorewhitespace(boolean ignore)
flag to ignore whitespace differences; default=false

Parameters: ignore if true ignore whitespace differences

setOriginalfile

public void setOriginalfile(File file)
The file to patch; optional if it can be inferred from the diff file

Parameters: file the file to patch

setPatchfile

public void setPatchfile(File file)
The file containing the diff output; required.

Parameters: file the file containing the diff output

setQuiet

public void setQuiet(boolean q)
Work silently unless an error occurs; optional, default=false

Parameters: q if true suppress set the -s option on the patch command

setReverse

public void setReverse(boolean r)
Assume patch was created with old and new files swapped; optional, default=false

Parameters: r if true set the -R option on the patch command

setStrip

public void setStrip(int num)
Strip the smallest prefix containing num leading slashes from filenames.

patch's -p option.

Parameters: num number of lines to strip

Throws: BuildException if num is < 0, or other errors