Class BooleanConditionTask

  • All Implemented Interfaces:
    java.lang.Cloneable, org.apache.tools.ant.TypeAdapter

    public class BooleanConditionTask
    extends org.apache.tools.ant.TaskAdapter
    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.
    Version:
    $Revision: 138 $
    • 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 Description
      BooleanConditionTask()
      Constructor for BooleanConditionTask
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean eval()
      Evaluates the condition object.
      void execute()
      Forwards to eval().
      java.lang.Object getProxy()
      Gets the proxy attribute of the BooleanConditionTask object
      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)
      Sets the proxy attribute of the BooleanConditionTask object
      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()
        Constructor for BooleanConditionTask
    • Method Detail

      • getProxy

        public java.lang.Object getProxy()
        Gets the proxy attribute of the BooleanConditionTask object
        Specified by:
        getProxy in interface org.apache.tools.ant.TypeAdapter
        Overrides:
        getProxy in class org.apache.tools.ant.TaskAdapter
        Returns:
        The proxy value
      • setProxy

        public void setProxy​(java.lang.Object proxy)
        Sets the proxy attribute of the BooleanConditionTask object
        Specified by:
        setProxy in interface org.apache.tools.ant.TypeAdapter
        Overrides:
        setProxy in class org.apache.tools.ant.TaskAdapter
        Parameters:
        proxy - The new proxy value
      • setProperty

        public void setProperty​(java.lang.String p)
        The name of the property to set. Optional.
        Parameters:
        p - The new property value
      • setValue

        public void setValue​(java.lang.String v)
        The value for the property to set, if condition evaluates to true. Defaults to "true".
        Parameters:
        v - The new value value
      • 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 - Description of Exception
        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 - Description of Exception
      • eval

        public boolean eval()
        Evaluates the condition object.
        Returns:
        true or false, depending on the evaluation of the condition.