hi,
i have written a small task combining the sequential task and the
if/unless condition of target. i call it conditional sequential. as of
now uptodate checks need a separate target. for example, from the docs
<target name="chkXmlBuild">
<uptodate property="xmlBuild.notRequired"
targetfile="${deploy}\xmlClasses.jar" >
<srcfiles dir= "${src}/xml" includes="**/*.dtd"/>
</uptodate>
</target>
<target name="xmlBuild" depends="chkXmlBuild"
unless="xmlBuild.notRequired">
DO SOMETHING
</target>
problem with this approach is that this way of check leads to something
like private and public targets. some that are to be used internally and
others thatthe users can call. but looking at it one cannot tell which
is which.
using my task one change keep both task in the same target.
<target name="xmlBuild">
<conditionalsequential unless="xmlBuild.notRequired" checkafter="1">
<uptodate property="xmlBuild.notRequired"
targetfile="${deploy}\xmlClasses.jar" >
<srcfiles dir= "${src}/xml" includes="**/*.dtd"/>
</uptodate>
DO SOMETHING
</conditionalsequential>
</target>
in this after the first (checkafter=1) task (ie uptodate) the unless
condition is checked just like done in target. if it succeeds then the
execution continues otherwise not.
i feel this is a cleaner way. kindly send me you comments.
i have attached the code which is just copy paste of Sequential task and
Target class.
thanks,
nishant.
--
Nishant Kumar <[EMAIL PROTECTED]>
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-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 "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 [EMAIL PROTECTED]
*
* 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 org.apache.tools.ant.Task;
import org.apache.tools.ant.TaskContainer;
import org.apache.tools.ant.BuildException;
import java.util.Vector;
import java.util.Enumeration;
/**
* ConditionalSequential is a container task - it can contain other Ant tasks. The nested
* tasks are simply executed in sequence. This is the same as Sequential.
* After <code>checkafter</code> number of subtasks have run, either an if or
* unless condition is checked, just like in target. If it fails then the remaining
* tasks are not executed.
*
* @author nishant kumar
*/
public class ConditionalSequential extends Task implements TaskContainer
{
/** Optional Vector holding the nested tasks */
private Vector nestedTasks = new Vector();
/** The "if" condition to test on execution. */
private String ifCondition = "";
/** The "unless" condition to test on execution. */
private String unlessCondition = "";
private int checkAfterIndex = -1;
/**
* Override [EMAIL PROTECTED] org.apache.tools.ant.Task#maybeConfigure
* maybeConfigure} in a way that leaves the nested tasks
* unconfigured until they get executed.
*
* @since Ant 1.5
*/
public void maybeConfigure() throws BuildException
{
if (isInvalid())
{
super.maybeConfigure();
} else
{
getRuntimeConfigurableWrapper().maybeConfigure(getProject(), false);
}
}
/**
* Add a nested task to Sequential.
* <p>
* @param nestedTask Nested task to execute Sequential
* <p>
*/
public void addTask(Task nestedTask)
{
nestedTasks.addElement(nestedTask);
}
/**
* Execute all nestedTasks.
*/
public void execute() throws BuildException
{
if ("".equals(this.ifCondition) && "".equals(this.unlessCondition))
throw new BuildException("either if or unless must be specified");
if (this.checkAfterIndex == -1)
throw new BuildException("checkafter must be specified");
if (this.checkAfterIndex >= (this.nestedTasks.size()))
throw new BuildException("checkafter should be less than the number of task in the sequence");
for (int i=0; i<this.nestedTasks.size() ; i++)
{
if (i == this.checkAfterIndex)
{
if (!(testIfCondition() && testUnlessCondition()))
return;
}
Task nestedTasks = (Task) this.nestedTasks.get(i);
nestedTasks.perform();
}
}
/**
* Sets the number of tasks after which the condition should
* be tested. Passing 0 here means that the condition is
* evaluated before running any task within this task.
* This number should be less than the number of task
* within this task.
*/
public void setCheckafter(int index)
{
this.checkAfterIndex = index;
}
/**
* Sets the "if" condition to test on execution. This is the
* name of a property to test for existence - if the property
* is not set, the task will not execute. The property goes
* through property substitution once before testing, so if
* property <code>foo</code> has value <code>bar</code>, setting
* the "if" condition to <code>${foo}_x</code> will mean that the
* task will only execute if property <code>bar_x</code> is set.
*
* @param property The property condition to test on execution.
* May be <code>null</code>, in which case
* no "if" test is performed.
*/
public void setIf(String property)
{
this.ifCondition = (property == null) ? "" : property;
}
/**
* Sets the "unless" condition to test on execution. This is the
* name of a property to test for existence - if the property
* is set, the task will not execute. The property goes
* through property substitution once before testing, so if
* property <code>foo</code> has value <code>bar</code>, setting
* the "unless" condition to <code>${foo}_x</code> will mean that the
* task will only execute if property <code>bar_x</code> isn't set.
*
* @param property The property condition to test on execution.
* May be <code>null</code>, in which case
* no "unless" test is performed.
*/
public void setUnless(String property)
{
this.unlessCondition = (property == null) ? "" : property;
}
/**
* Tests whether or not the "if" condition is satisfied.
*
* @return whether or not the "if" condition is satisfied. If no
* condition (or an empty condition) has been set,
* <code>true</code> is returned.
*
* @see #setIf(String)
*/
private boolean testIfCondition()
{
if ("".equals(ifCondition))
{
return true;
}
String test = project.replaceProperties(ifCondition);
return project.getProperty(test) != null;
}
/**
* Tests whether or not the "unless" condition is satisfied.
*
* @return whether or not the "unless" condition is satisfied. If no
* condition (or an empty condition) has been set,
* <code>true</code> is returned.
*
* @see #setUnless(String)
*/
private boolean testUnlessCondition()
{
if ("".equals(unlessCondition))
{
return true;
}
String test = project.replaceProperties(unlessCondition);
return project.getProperty(test) == null;
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
