net.sf.antcontrib.cpptasks.types

Class UndefineArgument

Known Direct Subclasses:
DefineArgument

public class UndefineArgument
extends java.lang.Object

Preprocessor macro undefinition.
Author:
Mark A Russell mark_russell@csg_systems.com

Constructor Summary

UndefineArgument()
UndefineArgument(boolean isDefine)

Method Summary

void
execute()
String
getName()
Returns the name of the define
String
getValue()
Returns the value of the define
boolean
isActive(org.apache.tools.ant.Project p)
Returns true if the define's if and unless conditions (if any) are satisfied.
boolean
isDefine()
Returns true if this is a define, false if an undefine.
static UndefineArgument[]
merge(UndefineArgument[] base, UndefineArgument[] override)
This method returns an array of UndefineArgument and DefineArgument's by merging a base list with an override list.
void
setIf(String propName)
Sets the property name for the 'if' condition.
void
setName(String name)
Set the name attribute
void
setUnless(String propName)
Set the property name for the 'unless' condition.

Constructor Details

UndefineArgument

public UndefineArgument()

UndefineArgument

protected UndefineArgument(boolean isDefine)

Method Details

execute

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

getName

public final String getName()
Returns the name of the define

getValue

public String getValue()
Returns the value of the define

isActive

public final boolean isActive(org.apache.tools.ant.Project p)
            throws BuildException
Returns true if the define's if and unless conditions (if any) are satisfied.

isDefine

public final boolean isDefine()
Returns true if this is a define, false if an undefine.

merge

public static UndefineArgument[] merge(UndefineArgument[] base,
                                       UndefineArgument[] override)
This method returns an array of UndefineArgument and DefineArgument's by merging a base list with an override list. Any define in the base list with a name that appears in the override list is suppressed. All entries in the override list are preserved

setIf

public final void setIf(String propName)
Sets the property name for the 'if' condition. The define will be ignored unless the property is defined. The value of the property is insignificant, but values that would imply misinterpretation ("false", "no") will throw an exception when evaluated.
Parameters:
propName - property name

setName

public final void setName(String name)
Set the name attribute

setUnless

public final void setUnless(String propName)
Set the property name for the 'unless' condition. If named property is set, the define will be ignored. The value of the property is insignificant, but values that would imply misinterpretation ("false", "no") of the behavior will throw an exception when evaluated.
Parameters:
propName - name of property

Copyright B) 2001-2006 Ant-Contrib project. All Rights Reserved.