From 2807b6e3f6f53c9fc7611e541e17a33ebf519ec2 Mon Sep 17 00:00:00 2001
From: Stefan Bodewig
Date: Mon, 9 Sep 2002 08:21:39 +0000
Subject: [PATCH] New condition.
git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@273309 13f79535-47bb-0310-9956-ffa450edef68
---
docs/manual/CoreTasks/conditions.html | 26 ++++
.../taskdefs/conditions/isreference.xml | 43 +++++++
.../ant/taskdefs/condition/ConditionBase.java | 7 ++
.../ant/taskdefs/condition/IsReference.java | 112 ++++++++++++++++++
.../org/apache/tools/ant/BuildFileTest.java | 16 +++
.../taskdefs/condition/IsReferenceTest.java | 98 +++++++++++++++
6 files changed, 302 insertions(+)
create mode 100644 src/etc/testcases/taskdefs/conditions/isreference.xml
create mode 100644 src/main/org/apache/tools/ant/taskdefs/condition/IsReference.java
create mode 100644 src/testcases/org/apache/tools/ant/taskdefs/condition/IsReferenceTest.java
diff --git a/docs/manual/CoreTasks/conditions.html b/docs/manual/CoreTasks/conditions.html
index eef5c597f..78a68db1f 100644
--- a/docs/manual/CoreTasks/conditions.html
+++ b/docs/manual/CoreTasks/conditions.html
@@ -292,6 +292,32 @@ that is "true","yes", or "on"
<isfalse value="false"/>
+isreference
+
+Test whether a given reference has been defined in this project and
+- optionally - is of an expected type.
+
+This condition has been added in Apache Ant 1.6.
+
+
+
+ Attribute |
+ Description |
+ Required |
+
+
+ refid |
+ The id of the reference to test. |
+ Yes |
+
+
+ type |
+ Name of the data type or task this reference is
+ expected to be. |
+ No |
+
+
+
Copyright © 2001-2002 Apache Software
Foundation. All rights Reserved.
diff --git a/src/etc/testcases/taskdefs/conditions/isreference.xml b/src/etc/testcases/taskdefs/conditions/isreference.xml
new file mode 100644
index 000000000..6469e68a7
--- /dev/null
+++ b/src/etc/testcases/taskdefs/conditions/isreference.xml
@@ -0,0 +1,43 @@
+
+
+
+
+
+ This build file should be run by a testcase
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/ConditionBase.java b/src/main/org/apache/tools/ant/taskdefs/condition/ConditionBase.java
index 1b2a978e7..8251e3caf 100644
--- a/src/main/org/apache/tools/ant/taskdefs/condition/ConditionBase.java
+++ b/src/main/org/apache/tools/ant/taskdefs/condition/ConditionBase.java
@@ -196,4 +196,11 @@ public abstract class ConditionBase extends ProjectComponent {
*/
public void addIsFalse(IsFalse test) {conditions.addElement(test);}
+ /**
+ * Add an <isreference> condition.
+ *
+ * @since Ant 1.6
+ */
+ public void addIsReference(IsReference i) {conditions.addElement(i);}
+
}
diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/IsReference.java b/src/main/org/apache/tools/ant/taskdefs/condition/IsReference.java
new file mode 100644
index 000000000..12447978e
--- /dev/null
+++ b/src/main/org/apache/tools/ant/taskdefs/condition/IsReference.java
@@ -0,0 +1,112 @@
+/*
+ * 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
+ * .
+ */
+
+package org.apache.tools.ant.taskdefs.condition;
+
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.ProjectComponent;
+import org.apache.tools.ant.types.Reference;
+
+/**
+ * Condition that tests whether a given reference has been defined.
+ *
+ * Optionally tests whether it is of a given type/class.
+ *
+ * @author Stefan Bodewig
+ * @since Ant 1.6
+ * @version $Revision$
+ */
+public class IsReference extends ProjectComponent implements Condition {
+ private Reference ref;
+ private String type;
+
+ public void setRefid(Reference r) {
+ ref = r;
+ }
+
+ public void setType(String type) {
+ this.type = type;
+ }
+
+ public boolean eval() throws BuildException {
+ if (ref == null) {
+ throw new BuildException("No reference specified for isreference "
+ + "condition");
+ }
+
+ Object o = getProject().getReference(ref.getRefId());
+
+ if (o == null) {
+ return false;
+ } else if (type == null) {
+ return true;
+ } else {
+ Class typeClass =
+ (Class) getProject().getDataTypeDefinitions().get(type);
+
+ if (typeClass == null) {
+ typeClass =
+ (Class) getProject().getTaskDefinitions().get(type);
+ }
+
+ if (typeClass == null) {
+ // don't know the type, should throw exception instead?
+ return false;
+ }
+
+ return typeClass.isAssignableFrom(o.getClass());
+ }
+ }
+
+}
diff --git a/src/testcases/org/apache/tools/ant/BuildFileTest.java b/src/testcases/org/apache/tools/ant/BuildFileTest.java
index 4d3a6cdc9..818d1926a 100644
--- a/src/testcases/org/apache/tools/ant/BuildFileTest.java
+++ b/src/testcases/org/apache/tools/ant/BuildFileTest.java
@@ -345,6 +345,22 @@ public abstract class BuildFileTest extends TestCase {
assertEquals("property " + property,value,result);
}
+ /**
+ * assert that a property equals "true"
+ * @param property property name
+ */
+ protected void assertPropertySet(String property) {
+ assertPropertyEquals(property, "true");
+ }
+
+ /**
+ * assert that a property is null
+ * @param property property name
+ */
+ protected void assertPropertyUnset(String property) {
+ assertPropertyEquals(property, null);
+ }
+
/**
* call a target, verify named property is "true".
diff --git a/src/testcases/org/apache/tools/ant/taskdefs/condition/IsReferenceTest.java b/src/testcases/org/apache/tools/ant/taskdefs/condition/IsReferenceTest.java
new file mode 100644
index 000000000..18f5bf559
--- /dev/null
+++ b/src/testcases/org/apache/tools/ant/taskdefs/condition/IsReferenceTest.java
@@ -0,0 +1,98 @@
+/*
+ * 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
+ * .
+ */
+package org.apache.tools.ant.taskdefs.condition;
+
+import org.apache.tools.ant.Project;
+import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.BuildFileTest;
+
+/**
+ * Testcases for the <isreference> condition.
+ *
+ * @author Stefan Bodewig
+ */
+public class IsReferenceTest extends BuildFileTest {
+
+ public IsReferenceTest(String name) {
+ super(name);
+ }
+
+ /**
+ * The JUnit setup method
+ */
+ public void setUp() {
+ configureProject("src/etc/testcases/taskdefs/conditions/isreference.xml");
+ }
+
+ public void testBasic() {
+ expectPropertySet("basic", "global-path");
+ assertPropertySet("target-path");
+ assertPropertyUnset("undefined");
+ }
+
+ public void testNotEnoughArgs() {
+ expectSpecificBuildException("isreference-incomplete",
+ "refid attribute has been omitted",
+ "No reference specified for isreference "
+ + "condition");
+ }
+
+ public void testType() {
+ expectPropertySet("type", "global-path");
+ assertPropertyUnset("global-path-as-fileset");
+ assertPropertyUnset("global-path-as-foo");
+ assertPropertySet("global-echo");
+ }
+
+}