net.sf.antcontrib.logic.condition

Class BooleanConditionTask

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.TaskAdapter

net.sf.antcontrib.logic.condition.BooleanConditionTask

All Implemented Interfaces:

java.lang.Cloneable, org.apache.tools.ant.taskdefs.condition.Condition, org.apache.tools.ant.TypeAdapter

public class BooleanConditionTask
extends org.apache.tools.ant.TaskAdapter
implements org.apache.tools.ant.taskdefs.condition.Condition

Wraps a ConditionBase so that the If task can use standard Ant Conditions as its evaluated boolean expression. Wrapping like this means that future additions to ConditionBase will automatically be picked up without modifying this class.

Developed for use with Antelope, migrated to ant-contrib Oct 2003.

Version:

$Revision: 1.3 $

Author:

Dale Anson, danson@germane-software.com

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

Constructors

Constructor and Description
BooleanConditionTask()

Method Summary

Modifier and Type	Method and Description
boolean	eval() Evaluates the condition object.
void	execute() Forwards to eval().
java.lang.Object	getProxy()
void	maybeConfigure() Override maybeConfigure in a way that leaves the nested tasks unconfigured until they get executed.
void	setProperty(java.lang.String p) The name of the property to set.
void	setProxy(java.lang.Object proxy)
void	setValue(java.lang.String v) The value for the property to set, if condition evaluates to true.

Methods inherited from class org.apache.tools.ant.TaskAdapter

checkProxyClass, checkTaskClass

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.tools.ant.TypeAdapter

getProject, setProject

Constructor Detail

BooleanConditionTask

public BooleanConditionTask()

Method Detail

getProxy

public java.lang.Object getProxy()

Specified by:

getProxy in interface org.apache.tools.ant.TypeAdapter

Overrides:

getProxy in class org.apache.tools.ant.TaskAdapter

setProxy

public void setProxy(java.lang.Object proxy)

Specified by:

setProxy in interface org.apache.tools.ant.TypeAdapter

Overrides:

setProxy in class org.apache.tools.ant.TaskAdapter

setProperty

public void setProperty(java.lang.String p)

The name of the property to set. Optional.

setValue

public void setValue(java.lang.String v)

The value for the property to set, if condition evaluates to true. Defaults to "true".

maybeConfigure

public void maybeConfigure()
                    throws org.apache.tools.ant.BuildException

Override maybeConfigure in a way that leaves the nested tasks unconfigured until they get executed.

Overrides:

maybeConfigure in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

Since:

Ant 1.5

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Forwards to eval().

Overrides:

execute in class org.apache.tools.ant.TaskAdapter

Throws:

org.apache.tools.ant.BuildException

eval

public boolean eval()

Evaluates the condition object.

Specified by:

eval in interface org.apache.tools.ant.taskdefs.condition.Condition

Returns:

true or false, depending on the evaluation of the condition.