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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
|
/*
* Copyright 2000-2004 Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.types;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import java.util.List;
import java.util.ArrayList;
import java.util.Iterator;
/**
* The assertion datatype. This type describes
* assertion settings for the <java> task and others.
* One can set the system assertions, and enable/disable those in
* packages and classes.
* Assertions can only be enabled or disabled when forking Java.
*
* Example: set system assertions and all org.apache packages except
* for ant, and the class org.apache.tools.ant.Main.
* <pre>
* <assertions enableSystemAssertions="true" >
* <enable package="org.apache" />
* <disable package="org.apache.ant" />
* <enable class="org.apache.tools.ant.Main"/>
* </assertions>
*</pre>
* Disable system assertions; enable those in the anonymous package
* <pre>
* <assertions enableSystemAssertions="false" >
* <enable package="..." />
* </assertions>
* </pre>
* enable assertions in a class called Test
* <pre>
* <assertions >
* <enable class="Test" />
* </assertions>
* </pre>
* This type is a datatype, so you can declare assertions and use them later
*
* <pre>
* <assertions id="project.assertions" >
* <enable project="org.apache.test" />
* </assertions>
*
* <assertions refid="project.assertions" />
*
* </pre>
* @since Ant 1.6
* @author steve loughran
*/
public class Assertions extends DataType {
/**
* enable/disable sys assertions; null means undefined
*/
private Boolean enableSystemAssertions;
/**
* list of type BaseAssertion
*/
private ArrayList assertionList = new ArrayList();
/**
* enable assertions
* @param assertion
*/
public void addEnable(EnabledAssertion assertion) {
checkChildrenAllowed();
assertionList.add(assertion);
}
/**
* disable assertions
* @param assertion
*/
public void addDisable(DisabledAssertion assertion) {
checkChildrenAllowed();
assertionList.add(assertion);
}
/**
* enable or disable system assertions
* @param enableSystemAssertions
*/
public void setEnableSystemAssertions(Boolean enableSystemAssertions) {
checkAttributesAllowed();
this.enableSystemAssertions = enableSystemAssertions;
}
/**
* Set the value of the refid attribute.
*
* <p>Subclasses may need to check whether any other attributes
* have been set as well or child elements have been created and
* thus override this method. if they do the must call
* <code>super.setRefid</code>.</p>
*/
public void setRefid(Reference ref) {
if (assertionList.size() > 0 || enableSystemAssertions != null) {
throw tooManyAttributes();
}
super.setRefid(ref);
}
/**
* get whatever we are referencing to. This could be ourself.
* @return the object that contains the assertion info
*/
private Assertions getFinalReference() {
if (getRefid() == null) {
return this;
} else {
Object o = getRefid().getReferencedObject(getProject());
if (!(o instanceof Assertions)) {
throw new BuildException("reference is of wrong type");
}
return (Assertions) o;
}
}
/**
* how many assertions are made...will resolve references before returning
* @return total # of commands to make
*/
public int size() {
Assertions clause = getFinalReference();
return clause.getFinalSize();
}
/**
* what is the final size of this object
* @return
*/
private int getFinalSize() {
return assertionList.size() + (enableSystemAssertions != null ? 1 : 0);
}
/**
* add the assertions to a list in a format suitable
* for adding to a command line
* @param commandList
*/
public void applyAssertions(List commandList) {
getProject().log("Applying assertions",Project.MSG_DEBUG);
Assertions clause = getFinalReference();
//do the system assertions
if (Boolean.TRUE.equals(clause.enableSystemAssertions)) {
getProject().log("Enabling system assertions", Project.MSG_DEBUG);
commandList.add("-enablesystemassertions");
} else if (Boolean.FALSE.equals(clause.enableSystemAssertions)) {
getProject().log("disabling system assertions", Project.MSG_DEBUG);
commandList.add("-disablesystemassertions");
}
//now any inner assertions
Iterator it = clause.assertionList.iterator();
while (it.hasNext()) {
BaseAssertion assertion = (BaseAssertion) it.next();
String arg = assertion.toCommand();
getProject().log("adding assertion "+arg, Project.MSG_DEBUG);
commandList.add(arg);
}
}
/**
* apply all the assertions to the command.
* @param command
*/
public void applyAssertions(CommandlineJava command) {
Assertions clause = getFinalReference();
//do the system assertions
if (Boolean.TRUE.equals(clause.enableSystemAssertions)) {
addVmArgument(command, "-enablesystemassertions");
} else if (Boolean.FALSE.equals(clause.enableSystemAssertions)) {
addVmArgument(command, "-disablesystemassertions");
}
//now any inner assertions
Iterator it = clause.assertionList.iterator();
while (it.hasNext()) {
BaseAssertion assertion = (BaseAssertion) it.next();
String arg = assertion.toCommand();
addVmArgument(command, arg);
}
}
/**
* helper method to add a string JVM argument to a command
* @param command
* @param arg
*/
private static void addVmArgument(CommandlineJava command, String arg) {
Commandline.Argument argument;
argument = command.createVmArgument();
argument.setValue(arg);
}
/**
* clone the objects.
* This is not a full depth clone; the list of assertions is cloned,
* but it does not clone the underlying assertions.
* @return a cli
* @throws CloneNotSupportedException
*/
protected Object clone() throws CloneNotSupportedException {
Assertions that = (Assertions) super.clone();
that.assertionList = (ArrayList) assertionList.clone();
return that;
}
/**
* base class for our assertion elements.
*/
public abstract static class BaseAssertion {
private String packageName;
private String className;
/**
* name a class
* @param className
*/
public void setClass(String className) {
this.className = className;
}
/**
* name a package
* @param packageName
*/
public void setPackage(String packageName) {
this.packageName = packageName;
}
/**
* what is the class name?
* @return classname or null
* @see #setClass
*/
protected String getClassName() {
return className;
}
/**
* what is the package name?
* @return package name or null
* @see #setPackage
*/
protected String getPackageName() {
return packageName;
}
/**
* get the prefix used to begin the command; -ea or -da.
* @return prefix
*/
public abstract String getCommandPrefix();
/**
* create a full command string from this class
* @throws BuildException in case of trouble
* @return
*/
public String toCommand() {
//catch invalidness
if (getPackageName() != null && getClassName() != null) {
throw new BuildException("Both package and class have been set");
}
StringBuffer command = new StringBuffer(getCommandPrefix());
//see if it is a package or a class
if (getPackageName() != null) {
//packages get a ... prefix
command.append(':');
command.append(getPackageName());
if (!command.toString().endsWith("...")) {
//append the ... suffix if not there already
command.append("...");
}
} else if (getClassName() != null) {
//classes just get the classname
command.append(':');
command.append(getClassName());
}
return command.toString();
}
}
/**
* an enabled assertion enables things
*/
public static class EnabledAssertion extends BaseAssertion {
/**
* get the prefix used to begin the command; -ea or -da.
* @return prefix
*/
public String getCommandPrefix() {
return "-ea";
}
}
/**
* A disabled assertion disables things
*/
public static class DisabledAssertion extends BaseAssertion {
/**
* get the prefix used to begin the command; -ea or -da.
* @return prefix
*/
public String getCommandPrefix() {
return "-da";
}
}
}
|