Package org.apache.tools.ant.taskdefs

Class Patch

  • All Implemented Interfaces:
    java.lang.Cloneable
    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

    • Constructor Detail

      • Patch

        public Patch()

    • Method Detail

      • setOriginalfile

        public void setOriginalfile​(java.io.File file)
        The file to patch; optional if it can be inferred from the diff file
        Parameters:
        file - the file to patch

      • setDestfile

        public void setDestfile​(java.io.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

      • setPatchfile

        public void setPatchfile​(java.io.File file)
        The file containing the diff output; required.
        Parameters:
        file - the file containing the diff output

      • setBackups

        public void setBackups​(boolean backups)
        flag to create backups; optional, default=false
        Parameters:
        backups - if true create backups

      • setIgnorewhitespace

        public void setIgnorewhitespace​(boolean ignore)
        flag to ignore whitespace differences; default=false
        Parameters:
        ignore - if true ignore whitespace differences

      • setStrip

        public void setStrip​(int num)
              throws BuildException
        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

      • 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

      • setDir

        public void setDir​(java.io.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