From 683d490074d93baa8a47db7ec43b7bd31145a12a Mon Sep 17 00:00:00 2001 From: Mark Donszelmann Date: Thu, 5 Nov 2009 23:00:15 +0100 Subject: Tar file expanded and committed --- .../cpptasks/types/UndefineArgument.html | 476 +++++++++++++++++++++ 1 file changed, 476 insertions(+) create mode 100644 site/apidocs/net/sf/antcontrib/cpptasks/types/UndefineArgument.html (limited to 'site/apidocs/net/sf/antcontrib/cpptasks/types/UndefineArgument.html') diff --git a/site/apidocs/net/sf/antcontrib/cpptasks/types/UndefineArgument.html b/site/apidocs/net/sf/antcontrib/cpptasks/types/UndefineArgument.html new file mode 100644 index 0000000..8b6711e --- /dev/null +++ b/site/apidocs/net/sf/antcontrib/cpptasks/types/UndefineArgument.html @@ -0,0 +1,476 @@ + + + + + + + +UndefineArgument (cpptasks 1.0b5 API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

+ +net.sf.antcontrib.cpptasks.types +
+Class UndefineArgument

+
+java.lang.Object
+  extended by net.sf.antcontrib.cpptasks.types.UndefineArgument
+
+
+
Direct Known Subclasses:
DefineArgument
+
+
+
+
public class UndefineArgument
extends java.lang.Object
+ + +

+Preprocessor macro undefinition. +

+ +

+

+
Author:
+
Mark A Russell mark_russell@csg_systems.com +
+
+
+ +

+ + + + + + + + + + + + + + + + +
+Constructor Summary
+ UndefineArgument() + +
+           
+protected UndefineArgument(boolean isDefine) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidexecute() + +
+           
+ java.lang.StringgetName() + +
+          Returns the name of the define
+ java.lang.StringgetValue() + +
+          Returns the value of the define
+ booleanisActive(org.apache.tools.ant.Project p) + +
+          Returns true if the define's if and unless conditions (if any) are + satisfied.
+ booleanisDefine() + +
+          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.
+ voidsetIf(java.lang.String propName) + +
+          Sets the property name for the 'if' condition.
+ voidsetName(java.lang.String name) + +
+          Set the name attribute
+ voidsetUnless(java.lang.String propName) + +
+          Set the property name for the 'unless' condition.
+ + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+UndefineArgument

+
+public UndefineArgument()
+
+
+
+ +

+UndefineArgument

+
+protected UndefineArgument(boolean isDefine)
+
+
+ + + + + + + + +
+Method Detail
+ +

+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 +

+

+
+
+
+
+ +

+execute

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

+getName

+
+public final java.lang.String getName()
+
+
Returns the name of the define +

+

+
+
+
+
+ +

+getValue

+
+public java.lang.String 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

+
+public final void setIf(java.lang.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(java.lang.String name)
+
+
Set the name attribute +

+

+
+
+
+
+ +

+setUnless

+
+public final void setUnless(java.lang.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 © 2001-2008 Ant-Contrib Project. All Rights Reserved. + + -- cgit v1.2.3