com.codemesh.terp.ant
Interface TerpAware

All Superinterfaces:

TerpContextHolder

All Known Subinterfaces:

CodeGenerator, CodeGeneratorOption, Compiler<C>, CppCompiler, Tool<T>

All Known Implementing Classes:

AbstractCodeGeneratorOption, Acc.Impl, BoundsChecker, CodeGeneratorImpl, CommandOption, CppCompilerImpl, DevPartnerTool, DynamicSourcesOption, Fail, Foreach, Foreach.Break, Foreach.Continue, Gcc.Impl, GenerateVsProject, Icc.Impl, ModelFileOption, ModelProperty, Msvc.Impl, Qcc.Impl, ResourceOption, Suncc.Impl, TerpAware.Delegate, TerpAwareTask, TerpEcho, TerpExec, TerpFileSet, TerpParallel, TerpProperty, TerpSequential, Xlc.Impl

public interface TerpAware
extends TerpContextHolder

An interface implemented by terp-aware tasks.

Nested Class Summary

static class

TerpAware.Delegate A utility class that implements the TerpAware interface.

Method Summary

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	setIf(java.lang.String condition) Sets a condition that must be satisfied to execute the implementing task.
void	setUnless(java.lang.String condition) Sets a condition that must not be satisfied to execute the implementing task.

Methods inherited from interface com.codemesh.terp.ant.TerpContextHolder

getContext, setContext

Method Detail

setIf

void setIf(java.lang.String condition)

Sets a condition that must be satisfied to execute the implementing task.

Parameters:

condition - a terp expression that must evaluate to a boolean value.

getIf

java.lang.String getIf()

Returns the condition that must be satidifed to execute the implementing task.

Returns:

the boolean expression.

setUnless

void setUnless(java.lang.String condition)

Sets a condition that must not be satisfied to execute the implementing task.

Parameters:

condition - a terp expression that must evaluate to a boolean value.

getUnless

java.lang.String getUnless()

Returns the condition that must not be satidifed to execute the implementing task.

Returns:

the boolean expression.

satisfiesConditions

boolean satisfiesConditions()

Returns true if both conditions are met.

Returns:

true or false.