terp - the ANT Tasks
v1.3.337

com.codemesh.terp.ant
Class Foreach

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by com.codemesh.terp.ant.Foreach
All Implemented Interfaces:
TerpAware, TerpContextHolder, java.lang.Cloneable, org.apache.tools.ant.TaskContainer

public class Foreach
extends org.apache.tools.ant.Task
implements org.apache.tools.ant.TaskContainer, TerpAware

A task that iterates over all elements in an iterable expression, applying the nested tasks to them.


Nested Class Summary
static class Foreach.Break
           
static class Foreach.BreakException
           
static class Foreach.Continue
           
static class Foreach.ContinueException
           
 
Nested classes/interfaces inherited from interface com.codemesh.terp.ant.TerpAware
TerpAware.Delegate
 
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
Foreach()
           
Foreach(org.apache.tools.ant.Project p)
           
 
Method Summary
 void addTask(org.apache.tools.ant.Task task)
           
 Foreach.Break createBreak()
           
 Foreach.Continue createContinue()
           
 void execute()
           
 TerpContext getContext()
          Returns the context maintained by this instance.
 java.lang.String getExpression()
           
 java.lang.String getIf()
          Returns the condition that must be satidifed to execute the implementing task.
 java.lang.String getName()
           
 java.lang.String getUnless()
          Returns the condition that must not be satidifed to execute the implementing task.
 boolean satisfiesConditions()
          Returns true if both conditions are met.
 void setContext(TerpContext ctx)
          Sets the context maintained by this instance.
 void setExpression(java.lang.String expr)
           
 void setIf(java.lang.String condition)
          Sets a condition that must be satisfied to execute the implementing task.
 void setIterable(java.lang.String iter)
           
 void setName(java.lang.String name)
           
 void setProject(org.apache.tools.ant.Project p)
           
 void setUnless(java.lang.String condition)
          Sets a condition that must not be satisfied to execute the implementing task.
 void setVar(java.lang.String name)
           
 void setVarname(java.lang.String name)
           
 
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, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Foreach

public Foreach()

Foreach

public Foreach(org.apache.tools.ant.Project p)
Method Detail

setProject

public void setProject(org.apache.tools.ant.Project p)
Overrides:
setProject in class org.apache.tools.ant.ProjectComponent

getContext

public TerpContext getContext()
Description copied from interface: TerpContextHolder
Returns the context maintained by this instance.

Specified by:
getContext in interface TerpContextHolder
Returns:
an execution context.

setContext

public void setContext(TerpContext ctx)
Description copied from interface: TerpContextHolder
Sets the context maintained by this instance.

Specified by:
setContext in interface TerpContextHolder
Parameters:
ctx - the execution context.

setVar

public void setVar(java.lang.String name)

setVarname

public void setVarname(java.lang.String name)

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setExpression

public void setExpression(java.lang.String expr)

setIterable

public void setIterable(java.lang.String iter)

getExpression

public java.lang.String getExpression()

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException

createBreak

public Foreach.Break createBreak()

createContinue

public Foreach.Continue createContinue()

addTask

public void addTask(org.apache.tools.ant.Task task)
Specified by:
addTask in interface org.apache.tools.ant.TaskContainer

getIf

public java.lang.String getIf()
Description copied from interface: TerpAware
Returns the condition that must be satidifed to execute the implementing task.

Specified by:
getIf in interface TerpAware
Returns:
the boolean expression.

getUnless

public java.lang.String getUnless()
Description copied from interface: TerpAware
Returns the condition that must not be satidifed to execute the implementing task.

Specified by:
getUnless in interface TerpAware
Returns:
the boolean expression.

satisfiesConditions

public boolean satisfiesConditions()
Description copied from interface: TerpAware
Returns true if both conditions are met.

Specified by:
satisfiesConditions in interface TerpAware
Returns:
true or false.

setIf

public void setIf(java.lang.String condition)
Description copied from interface: TerpAware
Sets a condition that must be satisfied to execute the implementing task.

Specified by:
setIf in interface TerpAware
Parameters:
condition - a terp expression that must evaluate to a boolean value.

setUnless

public void setUnless(java.lang.String condition)
Description copied from interface: TerpAware
Sets a condition that must not be satisfied to execute the implementing task.

Specified by:
setUnless in interface TerpAware
Parameters:
condition - a terp expression that must evaluate to a boolean value.

terp - the ANT Tasks
v1.3.337

Copyright © 2008-2016 by Codemesh, Inc. All Rights Reserved.