com.codemesh.terp.ant
Class TerpAwareTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          com.codemesh.terp.ant.TerpAwareTask

All Implemented Interfaces:

TerpAware, TerpContextHolder, java.lang.Cloneable

Direct Known Subclasses:

CodeGeneratorImpl, Fail, Foreach.Break, Foreach.Continue, TerpExec

public class TerpAwareTask
extends org.apache.tools.ant.Task
implements TerpAware

A generic do-nothing terp-aware task.

Nested Class Summary

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

TerpAwareTask()

TerpAwareTask(org.apache.tools.ant.Project p)

Method Summary

TerpContext	getContext() Returns the context maintained by this instance.
java.lang.String	getIf() Returns the condition that must be satidifed to execute the implementing task.
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	setIf(java.lang.String condition) Sets a condition that must be satisfied to execute the implementing task.
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.

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

bindToOwner, execute, 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

TerpAwareTask

public TerpAwareTask()

TerpAwareTask

public TerpAwareTask(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.

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.