1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Ant", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.tools.ant.taskdefs;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.util.Properties;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.util.FileUtils;
/**
* This is a basic task that can be used to track build numbers. 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.
*
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
* @version $Revision$ $Date$
* @since Ant 1.5
* @ant.task name="buildnumber"
*/
public class BuildNumber
extends Task {
/**
* The name of the property in which the build number is stored.
*/
private static final String DEFAULT_PROPERTY_NAME = "build.number";
/** The default filename to use if no file specified. */
private static final String DEFAULT_FILENAME = DEFAULT_PROPERTY_NAME;
/** The File in which the build number is stored. */
private File m_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.
*/
public void setFile(final File file) {
m_file = file;
}
/**
* Run task.
*
* @exception BuildException if an error occurs
*/
public void execute()
throws BuildException {
File savedFile = m_file;// 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(m_file);
final String header = "Build Number for ANT. Do not edit!";
properties.save(output, header);
} catch (final IOException ioe) {
final String message = "Error while writing " + m_file;
throw new BuildException(message, ioe);
} finally {
if (null != output) {
try {
output.close();
} catch (final IOException ioe) {
}
}
m_file = savedFile;
}
//Finally set the property
getProject().setNewProperty(DEFAULT_PROPERTY_NAME,
String.valueOf(buildNumber));
}
/**
* 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
*/
private int getBuildNumber(final Properties properties)
throws BuildException {
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 =
m_file + " contains a non integer build number: " + buildNumber;
throw new BuildException(message, nfe);
}
}
/**
* Utility method to load properties from file.
*
* @return the loaded properties
* @throws BuildException
*/
private Properties loadProperties()
throws BuildException {
FileInputStream input = null;
try {
final Properties properties = new Properties();
input = new FileInputStream(m_file);
properties.load(input);
return properties;
} catch (final IOException ioe) {
throw new BuildException(ioe);
} finally {
if (null != input) {
try {
input.close();
} catch (final IOException ioe) {
}
}
}
}
/**
* Validate that the task parameters are valid.
*
* @throws BuildException if parameters are invalid
*/
private void validate()
throws BuildException {
if (null == m_file) {
m_file = getProject().resolveFile(DEFAULT_FILENAME);
}
if (!m_file.exists()) {
try {
FileUtils.newFileUtils().createNewFile(m_file);
} catch (final IOException ioe) {
final String message =
m_file + " doesn't exist and new file can't be created.";
throw new BuildException(message, ioe);
}
}
if (!m_file.canRead()) {
final String message = "Unable to read from " + m_file + ".";
throw new BuildException(message);
}
if (!m_file.canWrite()) {
final String message = "Unable to write to " + m_file + ".";
throw new BuildException(message);
}
}
}
|
