From 01b79d1810e4e43613b9b29dd3f524a301ff1370 Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Wed, 20 Feb 2002 08:36:27 +0000 Subject: [PATCH] Add a new condition that looks for substrings. Names are open to discussion, of course. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@271444 13f79535-47bb-0310-9956-ffa450edef68 --- WHATSNEW | 2 +- docs/manual/CoreTasks/conditions.html | 26 ++++ .../ant/taskdefs/condition/ConditionBase.java | 17 ++- .../ant/taskdefs/condition/Contains.java | 111 ++++++++++++++++++ .../ant/taskdefs/condition/ContainsTest.java | 82 +++++++++++++ 5 files changed, 232 insertions(+), 6 deletions(-) create mode 100644 src/main/org/apache/tools/ant/taskdefs/condition/Contains.java create mode 100644 src/testcases/org/apache/tools/ant/taskdefs/condition/ContainsTest.java diff --git a/WHATSNEW b/WHATSNEW index 76722cac1..6f64f9614 100644 --- a/WHATSNEW +++ b/WHATSNEW @@ -114,7 +114,7 @@ Other changes: * Added a new condition that test for the existence of a property to the condition task. -* Added a new conditions , , . +* Added a new conditions , , , . * Ant's testcases require JUnit 3.7 or above as they now use the new assertTrue method instead of assert. diff --git a/docs/manual/CoreTasks/conditions.html b/docs/manual/CoreTasks/conditions.html index b89a232fe..9c0eb006a 100644 --- a/docs/manual/CoreTasks/conditions.html +++ b/docs/manual/CoreTasks/conditions.html @@ -212,6 +212,32 @@ or the filenames match the answer is so obvious the detailed test is omitted. +

contains

+

Tests whether the a given Strings contains another one.

+ + + + + + + + + + + + + + + + + + + + + +
AttributeDescriptionRequired
stringThe string to search in.Yes
substringThe string to search for.Yes
casesensitivePerform a case sensitive comparision. Default is + true.No
+

Copyright © 2001-2002 Apache Software Foundation. All rights Reserved.

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 b310a7d46..541b74d59 100644 --- a/src/main/org/apache/tools/ant/taskdefs/condition/ConditionBase.java +++ b/src/main/org/apache/tools/ant/taskdefs/condition/ConditionBase.java @@ -101,7 +101,7 @@ public abstract class ConditionBase extends ProjectComponent { /** * Add an <checksum> condition. * - * @since 1.4 + * @since 1.4, Ant 1.5 */ public void addChecksum(Checksum c) {conditions.addElement(c);} @@ -150,31 +150,38 @@ public abstract class ConditionBase extends ProjectComponent { /** * Add an <isset> condition. * - * @since 1.1 + * @since 1.2, Ant 1.5 */ public void addIsSet(IsSet i) {conditions.addElement(i);} /** * Add an <http> condition. * - * @since 1.7 + * @since 1.7, Ant 1.5 */ public void addHttp(Http h) {conditions.addElement(h);} /** * Add a <socket> condition. * - * @since 1.7 + * @since 1.7, Ant 1.5 */ public void addSocket(Socket s) {conditions.addElement(s);} /** * Add a <filesmatch> condition. * - * @since 1.8 + * @since 1.8, Ant 1.5 */ public void addFilesMatch(FilesMatch test) {conditions.addElement(test);} + /** + * Add a <filesmatch> condition. + * + * @since 1.10, Ant 1.5 + */ + public void addContains(Contains test) {conditions.addElement(test);} + /** * Inner class that configures those conditions with a project * instance that need it. diff --git a/src/main/org/apache/tools/ant/taskdefs/condition/Contains.java b/src/main/org/apache/tools/ant/taskdefs/condition/Contains.java new file mode 100644 index 000000000..f4f2a3284 --- /dev/null +++ b/src/main/org/apache/tools/ant/taskdefs/condition/Contains.java @@ -0,0 +1,111 @@ +/* + * 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; + +/** + * Is one string part of another string? + * + * @author Stefan Bodewig + * @version $Revision$ + * + * @since Ant 1.5 + */ +public class Contains implements Condition { + + private String string, subString; + private boolean caseSensitive = true; + + /** + * The string to search in. + * + * @since 1.1, Ant 1.5 + */ + public void setString(String a1) { + string = a1; + } + + /** + * The string to search for. + * + * @since 1.1, Ant 1.5 + */ + public void setSubstring(String a2) { + subString = a2; + } + + /** + * Whether to search ignoring case or not. + * + * @since 1.1, Ant 1.5 + */ + public void setCasesensitive(boolean b) { + caseSensitive = b; + } + + /** + * @since 1.1, Ant 1.5 + */ + public boolean eval() throws BuildException { + if (string == null || subString == null) { + throw new BuildException("both string and substring are required in contains"); + } + + return caseSensitive + ? string.indexOf(subString) > -1 + : string.toLowerCase().indexOf(subString.toLowerCase()) > -1; + } +} diff --git a/src/testcases/org/apache/tools/ant/taskdefs/condition/ContainsTest.java b/src/testcases/org/apache/tools/ant/taskdefs/condition/ContainsTest.java new file mode 100644 index 000000000..2067d622e --- /dev/null +++ b/src/testcases/org/apache/tools/ant/taskdefs/condition/ContainsTest.java @@ -0,0 +1,82 @@ +/* + * 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 junit.framework.TestCase; + +/** + * Testcase for the <contains> condition. + * + * @author Stefan Bodewig + * @version $Revision$ + */ +public class ContainsTest extends TestCase { + + public ContainsTest(String name) { + super(name); + } + + public void testCaseSensitive() { + Contains con = new Contains(); + con.setString("abc"); + con.setSubstring("A"); + con.eval(); + assertTrue(!con.eval()); + + con.setCasesensitive(false); + assertTrue(con.eval()); + } + +}