FileDocCategorySizeDatePackage
BuildNumber.javaAPI DocApache Ant 1.706311Wed Dec 13 06:16:24 GMT 2006org.apache.tools.ant.taskdefs

BuildNumber

public class BuildNumber extends org.apache.tools.ant.Task
Read, increment, and write a build number in a file It will first attempt to read a build number from a file, then set the property "build.number" to the value that was read in (or 0 if no such value). Then it will increment the build number by one and write it back out into the file.
since
Ant 1.5
ant.task
name="buildnumber"

Fields Summary
private static final String
DEFAULT_PROPERTY_NAME
The name of the property in which the build number is stored.
private static final String
DEFAULT_FILENAME
The default filename to use if no file specified.
private static final org.apache.tools.ant.util.FileUtils
FILE_UTILS
private File
myFile
The File in which the build number is stored.
Constructors Summary
Methods Summary
public voidexecute()
Run task.

exception
BuildException if an error occurs

        File savedFile = myFile; // may be altered in validate

        validate();

        final Properties properties = loadProperties();
        final int buildNumber = getBuildNumber(properties);

        properties.put(DEFAULT_PROPERTY_NAME,
            String.valueOf(buildNumber + 1));

        // Write the properties file back out
        FileOutputStream output = null;

        try {
            output = new FileOutputStream(myFile);

            final String header = "Build Number for ANT. Do not edit!";

            properties.store(output, header);
        } catch (final IOException ioe) {
            final String message = "Error while writing " + myFile;

            throw new BuildException(message, ioe);
        } finally {
            if (null != output) {
                try {
                    output.close();
                } catch (final IOException ioe) {
                    log("error closing output stream " + ioe, Project.MSG_ERR);
                }
            }
            myFile = savedFile;
        }

        //Finally set the property
        getProject().setNewProperty(DEFAULT_PROPERTY_NAME,
            String.valueOf(buildNumber));
private intgetBuildNumber(java.util.Properties properties)
Utility method to retrieve build number from properties object.

param
properties the properties to retrieve build number from
return
the build number or if no number in properties object
throws
BuildException if build.number property is not an integer

        final String buildNumber =
            properties.getProperty(DEFAULT_PROPERTY_NAME, "0").trim();

        // Try parsing the line into an integer.
        try {
            return Integer.parseInt(buildNumber);
        } catch (final NumberFormatException nfe) {
            final String message =
                myFile + " contains a non integer build number: " + buildNumber;
            throw new BuildException(message, nfe);
        }
private java.util.PropertiesloadProperties()
Utility method to load properties from file.

return
the loaded properties
throws
BuildException

        FileInputStream input = null;

        try {
            final Properties properties = new Properties();

            input = new FileInputStream(myFile);
            properties.load(input);
            return properties;
        } catch (final IOException ioe) {
            throw new BuildException(ioe);
        } finally {
            if (null != input) {
                try {
                    input.close();
                } catch (final IOException ioe) {
                    log("error closing input stream " + ioe, Project.MSG_ERR);
                }
            }
        }
public voidsetFile(java.io.File file)
The file in which the build number is stored. Defaults to "build.number" if not specified.

param
file the file in which build number is stored.



                                  
         
        myFile = file;
private voidvalidate()
Validate that the task parameters are valid.

throws
BuildException if parameters are invalid

        if (null == myFile) {
            myFile = FILE_UTILS.resolveFile(getProject().getBaseDir(), DEFAULT_FILENAME);
        }

        if (!myFile.exists()) {
            try {
                FILE_UTILS.createNewFile(myFile);
            } catch (final IOException ioe) {
                final String message =
                    myFile + " doesn't exist and new file can't be created.";
                throw new BuildException(message, ioe);
            }
        }

        if (!myFile.canRead()) {
            final String message = "Unable to read from " + myFile + ".";
            throw new BuildException(message);
        }

        if (!myFile.canWrite()) {
            final String message = "Unable to write to " + myFile + ".";
            throw new BuildException(message);
        }