Probe for the maven repository being reachable using the hostname, ten second timeout..
+ +This condition is a facet of the Length task. + It is used to test the length of a string or one or more files. + Since Ant 1.6.3 +
+ +Verify a string is of a certain length: ++<length string=" foo " trim="true" length="3"/> ++ +Verify a file is not empty: +
+<length file="foo" when="greater" length="0"/> ++
Copyright © 2001-2005 Apache Software Foundation. All rights Reserved.
diff --git a/docs/manual/CoreTasks/length.html b/docs/manual/CoreTasks/length.html index 7f0772818..b96de225a 100755 --- a/docs/manual/CoreTasks/length.html +++ b/docs/manual/CoreTasks/length.html @@ -11,7 +11,8 @@Display or set a property containing length information for - a string, a file, or one or more nested filesets.
+ a string, a file, or one or more nested filesets. Can also + be used as a condition. Since Ant 1.6.3| property | The property to set. If omitted - the length is written to the log. | + the results are written to the log. Ignored when + processing as a condition.No |
| File length mode; when "all" the resulting value is the sum of all included files' lengths; when "each" the task outputs the absolute path and length of each included file, - one per line. | + one per line. Ignored when processing as a condition.No; default is "all" | |
| Whether to trim when operating on a string. | No; only valid when string is set | |
| length | +Comparison length for processing as a condition. | +Yes, in condition mode | +
| when | +Comparison type: "equal", "greater", "less" + for use when operating as a condition. | +No; default is "equal" | +
You can include files via nested
diff --git a/src/etc/testcases/taskdefs/length.xml b/src/etc/testcases/taskdefs/length.xml
index b0ab47f24..e163fdc40 100644
--- a/src/etc/testcases/taskdefs/length.xml
+++ b/src/etc/testcases/taskdefs/length.xml
@@ -35,6 +35,27 @@
+ FileSet to add.
*/
public synchronized void add(FileSet fs) {
+ if (fs == null) {
+ return;
+ }
filesets = (filesets == null) ? new Vector() : filesets;
filesets.add(fs);
}
+ /**
+ * Set the target count number for use as a Condition.
+ * @param ell the long length to compare with.
+ */
+ public synchronized void setLength(long ell) {
+ length = new Long(ell);
+ }
+
+ /**
+ * Set the comparison criteria for use as a Condition:
+ * "equal", "greater", "less". Default is "equal".
+ * @param w EnumeratedAttribute When.
+ */
+ public synchronized void setWhen(When w) {
+ when = w;
+ }
+
/**
* Set the execution mode for working with files.
* @param m the FileMode to use.
@@ -102,6 +128,14 @@ public class Length extends Task {
this.trim = trim ? Boolean.TRUE : Boolean.FALSE;
}
+ /**
+ * Learn whether strings will be trimmed.
+ * @return boolean trim setting.
+ */
+ public boolean getTrim() {
+ return trim != null && trim.booleanValue();
+ }
+
/**
* Execute the length task.
*/
@@ -112,14 +146,38 @@ public class Length extends Task {
: (OutputStream) new LogOutputStream(this, Project.MSG_INFO));
if (STRING.equals(mode)) {
- ps.print(((trim != null && trim.booleanValue())
- ? string.trim() : string).length());
+ ps.print(getLength(string, getTrim()));
ps.close();
} else if (EACH.equals(mode)) {
- handleFilesets(new EachHandler(ps));
+ handleResources(new EachHandler(ps));
} else if (ALL.equals(mode)) {
- handleFilesets(new AllHandler(ps));
+ handleResources(new AllHandler(ps));
+ }
+ }
+
+ /**
+ * Fulfill the condition contract.
+ * @return true if the condition is true.
+ * @throws BuildException if an error occurs.
+ */
+ public boolean eval() {
+ validate();
+ if (length == null) {
+ throw new BuildException(LENGTH_REQUIRED);
+ }
+ Long ell = null;
+ if (STRING.equals(mode)) {
+ ell = new Long(getLength(string, getTrim()));
+ } else {
+ ConditionHandler h = new ConditionHandler();
+ handleResources(h);
+ ell = new Long(h.getLength());
}
+ int w = when.getIndex();
+ int comp = ell.compareTo(length);
+ return (w == 0 && comp == 0)
+ || (w == 1 && comp > 0)
+ || (w == 2 && comp < 0);
}
private void validate() {
@@ -130,9 +188,9 @@ public class Length extends Task {
}
if (!(STRING.equals(mode))) {
throw new BuildException("the mode attribute is for use"
- + " with the file length function");
+ + " with the file/resource length function");
}
- } else if (filesets != null && filesets.size() > 0) {
+ } else if (filesets != null) {
if (!(EACH.equals(mode) || ALL.equals(mode))) {
throw new BuildException("invalid mode setting for"
+ " file length function: \"" + mode + "\"");
@@ -147,10 +205,9 @@ public class Length extends Task {
}
}
- private void handleFilesets(Handler h) {
- HashSet included = new HashSet(filesets.size());
- for (int i = 0; i < filesets.size(); i++) {
- FileSet fs = (FileSet) (filesets.get(i));
+ private void handleResources(Handler h) {
+ for (Iterator i = filesets.iterator(); i.hasNext();) {
+ FileSet fs = (FileSet) i.next();
DirectoryScanner ds = fs.getDirectoryScanner(getProject());
String[] f = ds.getIncludedFiles();
for (int j = 0; j < f.length; j++) {
@@ -161,24 +218,22 @@ public class Length extends Task {
log(r.getName() + " is a directory; length unspecified",
Project.MSG_ERR);
} else {
- //clone the Resource and alter path
+ //force a full path:
File basedir = ds.getBasedir();
- if (basedir != null) {
- r = (Resource) (r.clone());
- r.setName(FileUtils.getFileUtils().resolveFile(
- basedir, r.getName()).getAbsolutePath());
- }
- if (included.add(r.getName())) {
- h.handle(r);
- }
+ String s = FileUtils.getFileUtils().resolveFile(
+ basedir, r.getName()).getAbsolutePath();
+ h.handle(new Resource(s, true,
+ r.getLastModified(), false, r.getSize()));
}
}
}
- included.clear();
- included = null;
h.complete();
}
+ private static long getLength(String s, boolean t) {
+ return (t ? s.trim() : s).length();
+ }
+
/** EnumeratedAttribute operation mode */
public static class FileMode extends EnumeratedAttribute {
static final String[] MODES = new String[] {EACH, ALL};
@@ -193,6 +248,25 @@ public class Length extends Task {
}
+ /**
+ * EnumeratedAttribute for the when attribute.
+ */
+ public static class When extends EnumeratedAttribute {
+ private static final String[] VALUES
+ = new String[] {"equal", "greater", "less"};
+
+ private static final When EQUAL = new When("equal");
+
+ public When() {
+ }
+ public When(String value) {
+ setValue(value);
+ }
+ public String[] getValues() {
+ return VALUES;
+ }
+ }
+
private class PropertyOutputStream extends ByteArrayOutputStream {
public void close() {
getProject().setNewProperty(
@@ -231,7 +305,7 @@ public class Length extends Task {
}
private class AllHandler extends Handler {
- long length = 0L;
+ long accum = 0L;
AllHandler(PrintStream ps) {
super(ps);
}
@@ -240,12 +314,23 @@ public class Length extends Task {
if (size == Resource.UNKNOWN_SIZE) {
log("Size unknown for " + r.getName(), Project.MSG_WARN);
} else {
- length += size;
+ accum += size;
}
}
void complete() {
- ps.print(length);
+ ps.print(accum);
super.complete();
}
}
+
+ private class ConditionHandler extends AllHandler {
+ ConditionHandler() {
+ super(null);
+ }
+ void complete() {
+ }
+ long getLength() {
+ return accum;
+ }
+ }
}
diff --git a/src/testcases/org/apache/tools/ant/taskdefs/LengthTest.java b/src/testcases/org/apache/tools/ant/taskdefs/LengthTest.java
index e9b741c99..a1e347703 100755
--- a/src/testcases/org/apache/tools/ant/taskdefs/LengthTest.java
+++ b/src/testcases/org/apache/tools/ant/taskdefs/LengthTest.java
@@ -37,26 +37,66 @@ public class LengthTest extends BuildFileTest {
executeTarget("testEach");
}
+ public void testEachCondition() {
+ executeTarget("testEachCondition");
+ }
+
public void testAll() {
executeTarget("testAll");
}
+ public void testAllCondition() {
+ executeTarget("testAllCondition");
+ }
+
public void testFile() {
executeTarget("testFile");
}
+ public void testFileCondition() {
+ executeTarget("testFileCondition");
+ }
+
public void testBoth() {
executeTarget("testBoth");
}
+ public void testBothCondition() {
+ executeTarget("testBothCondition");
+ }
+
public void testDupes() {
executeTarget("testDupes");
}
+ public void testDupesCondition() {
+ executeTarget("testDupesCondition");
+ }
+
public void testString() {
executeTarget("testString");
}
+ public void testStringCondition() {
+ executeTarget("testStringCondition");
+ }
+
+ public void testTrimString() {
+ executeTarget("testTrimString");
+ }
+
+ public void testTrimStringCondition() {
+ executeTarget("testTrimStringCondition");
+ }
+
+ public void testNoTrimString() {
+ executeTarget("testNoTrimString");
+ }
+
+ public void testNoTrimStringCondition() {
+ executeTarget("testNoTrimStringCondition");
+ }
+
public void testStringFile() {
expectBuildExceptionContaining("testStringFile",
"should fail", "incompatible");
@@ -74,4 +114,9 @@ public class LengthTest extends BuildFileTest {
public void testZipFileSet() {
executeTarget("testZipFileSet");
}
+
+ public void testZipFileSetCondition() {
+ executeTarget("testZipFileSetCondition");
+ }
+
}