Package net.sf.antcontrib.cpptasks.types
Class UndefineArgument
java.lang.Object
net.sf.antcontrib.cpptasks.types.UndefineArgument
- Direct Known Subclasses:
DefineArgument
Preprocessor macro undefinition.
- Author:
- Mark A Russell mark_russell@csg_systems.com
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
final String
getName()
Returns the name of the definegetValue()
Returns the value of the definefinal boolean
isActive
(org.apache.tools.ant.Project p) Returns true if the define's if and unless conditions (if any) are satisfied.final 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.final void
Sets the property name for the 'if' condition.final void
Set the name attributefinal void
Set the property name for the 'unless' condition.
-
Constructor Details
-
UndefineArgument
public UndefineArgument() -
UndefineArgument
protected UndefineArgument(boolean isDefine)
-
-
Method Details
-
merge
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 -
execute
public void execute() throws org.apache.tools.ant.BuildException- Throws:
org.apache.tools.ant.BuildException
-
getName
Returns the name of the define -
getValue
Returns the value of the define -
isActive
public final boolean isActive(org.apache.tools.ant.Project p) throws org.apache.tools.ant.BuildException Returns true if the define's if and unless conditions (if any) are satisfied.- Throws:
org.apache.tools.ant.BuildException
- throws build exception if name is not set
-
isDefine
public final boolean isDefine()Returns true if this is a define, false if an undefine. -
setIf
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
Set the name attribute -
setUnless
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
-