diff options
Diffstat (limited to 'site/apidocs/net/sf/antcontrib/cpptasks/types/UndefineArgument.html')
| -rw-r--r-- | site/apidocs/net/sf/antcontrib/cpptasks/types/UndefineArgument.html | 476 |
1 files changed, 476 insertions, 0 deletions
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 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!--NewPage--> +<HTML> +<HEAD> +<!-- Generated by javadoc (build 1.5.0_13) on Wed Apr 02 19:28:41 CDT 2008 --> +<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> +<TITLE> +UndefineArgument (cpptasks 1.0b5 API) +</TITLE> + +<META NAME="keywords" CONTENT="net.sf.antcontrib.cpptasks.types.UndefineArgument class"> + +<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> + +<SCRIPT type="text/javascript"> +function windowTitle() +{ + parent.document.title="UndefineArgument (cpptasks 1.0b5 API)"; +} +</SCRIPT> +<NOSCRIPT> +</NOSCRIPT> + +</HEAD> + +<BODY BGCOLOR="white" onload="windowTitle();"> + + +<!-- ========= START OF TOP NAVBAR ======= --> +<A NAME="navbar_top"><!-- --></A> +<A HREF="#skip-navbar_top" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_top_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/UndefineArgument.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../net/sf/antcontrib/cpptasks/types/SystemLibrarySet.html" title="class in net.sf.antcontrib.cpptasks.types"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?net/sf/antcontrib/cpptasks/types/UndefineArgument.html" target="_top"><B>FRAMES</B></A> + <A HREF="UndefineArgument.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_top"></A> +<!-- ========= END OF TOP NAVBAR ========= --> + +<HR> +<!-- ======== START OF CLASS DATA ======== --> +<H2> +<FONT SIZE="-1"> +net.sf.antcontrib.cpptasks.types</FONT> +<BR> +Class UndefineArgument</H2> +<PRE> +java.lang.Object + <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>net.sf.antcontrib.cpptasks.types.UndefineArgument</B> +</PRE> +<DL> +<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/DefineArgument.html" title="class in net.sf.antcontrib.cpptasks.types">DefineArgument</A></DD> +</DL> +<HR> +<DL> +<DT><PRE>public class <B>UndefineArgument</B><DT>extends java.lang.Object</DL> +</PRE> + +<P> +Preprocessor macro undefinition. +<P> + +<P> +<DL> +<DT><B>Author:</B></DT> + <DD>Mark A Russell <a + href="mailto:mark_russell@csgsystems.com">mark_russell@csg_systems.com + </a></DD> +</DL> +<HR> + +<P> + +<!-- ======== CONSTRUCTOR SUMMARY ======== --> + +<A NAME="constructor_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Constructor Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> </CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#UndefineArgument()">UndefineArgument</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>protected </CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#UndefineArgument(boolean)">UndefineArgument</A></B>(boolean isDefine)</CODE> + +<BR> + </TD> +</TR> +</TABLE> + +<!-- ========== METHOD SUMMARY =========== --> + +<A NAME="method_summary"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> +<B>Method Summary</B></FONT></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#execute()">execute</A></B>()</CODE> + +<BR> + </TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#getName()">getName</A></B>()</CODE> + +<BR> + Returns the name of the define</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> java.lang.String</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#getValue()">getValue</A></B>()</CODE> + +<BR> + Returns the value of the define</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#isActive(org.apache.tools.ant.Project)">isActive</A></B>(org.apache.tools.ant.Project p)</CODE> + +<BR> + Returns true if the define's if and unless conditions (if any) are + satisfied.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> boolean</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#isDefine()">isDefine</A></B>()</CODE> + +<BR> + Returns true if this is a define, false if an undefine.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE>static <A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html" title="class in net.sf.antcontrib.cpptasks.types">UndefineArgument</A>[]</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#merge(net.sf.antcontrib.cpptasks.types.UndefineArgument[], net.sf.antcontrib.cpptasks.types.UndefineArgument[])">merge</A></B>(<A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html" title="class in net.sf.antcontrib.cpptasks.types">UndefineArgument</A>[] base, + <A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html" title="class in net.sf.antcontrib.cpptasks.types">UndefineArgument</A>[] override)</CODE> + +<BR> + This method returns an array of UndefineArgument and DefineArgument's by + merging a base list with an override list.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#setIf(java.lang.String)">setIf</A></B>(java.lang.String propName)</CODE> + +<BR> + Sets the property name for the 'if' condition.</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE> + +<BR> + Set the name attribute</TD> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> +<CODE> void</CODE></FONT></TD> +<TD><CODE><B><A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html#setUnless(java.lang.String)">setUnless</A></B>(java.lang.String propName)</CODE> + +<BR> + Set the property name for the 'unless' condition.</TD> +</TR> +</TABLE> + <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> +<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> +</TR> +<TR BGCOLOR="white" CLASS="TableRowColor"> +<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> +</TR> +</TABLE> + +<P> + +<!-- ========= CONSTRUCTOR DETAIL ======== --> + +<A NAME="constructor_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Constructor Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="UndefineArgument()"><!-- --></A><H3> +UndefineArgument</H3> +<PRE> +public <B>UndefineArgument</B>()</PRE> +<DL> +</DL> +<HR> + +<A NAME="UndefineArgument(boolean)"><!-- --></A><H3> +UndefineArgument</H3> +<PRE> +protected <B>UndefineArgument</B>(boolean isDefine)</PRE> +<DL> +</DL> + +<!-- ============ METHOD DETAIL ========== --> + +<A NAME="method_detail"><!-- --></A> +<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> +<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> +<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> +<B>Method Detail</B></FONT></TH> +</TR> +</TABLE> + +<A NAME="merge(net.sf.antcontrib.cpptasks.types.UndefineArgument[], net.sf.antcontrib.cpptasks.types.UndefineArgument[])"><!-- --></A><H3> +merge</H3> +<PRE> +public static <A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html" title="class in net.sf.antcontrib.cpptasks.types">UndefineArgument</A>[] <B>merge</B>(<A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html" title="class in net.sf.antcontrib.cpptasks.types">UndefineArgument</A>[] base, + <A HREF="../../../../../net/sf/antcontrib/cpptasks/types/UndefineArgument.html" title="class in net.sf.antcontrib.cpptasks.types">UndefineArgument</A>[] override)</PRE> +<DL> +<DD>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 +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="execute()"><!-- --></A><H3> +execute</H3> +<PRE> +public void <B>execute</B>() + throws org.apache.tools.ant.BuildException</PRE> +<DL> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>org.apache.tools.ant.BuildException</CODE></DL> +</DD> +</DL> +<HR> + +<A NAME="getName()"><!-- --></A><H3> +getName</H3> +<PRE> +public final java.lang.String <B>getName</B>()</PRE> +<DL> +<DD>Returns the name of the define +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="getValue()"><!-- --></A><H3> +getValue</H3> +<PRE> +public java.lang.String <B>getValue</B>()</PRE> +<DL> +<DD>Returns the value of the define +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="isActive(org.apache.tools.ant.Project)"><!-- --></A><H3> +isActive</H3> +<PRE> +public final boolean <B>isActive</B>(org.apache.tools.ant.Project p) + throws org.apache.tools.ant.BuildException</PRE> +<DL> +<DD>Returns true if the define's if and unless conditions (if any) are + satisfied. +<P> +<DD><DL> + +<DT><B>Throws:</B> +<DD><CODE>org.apache.tools.ant.BuildException</CODE> - throws build exception if name is not set</DL> +</DD> +</DL> +<HR> + +<A NAME="isDefine()"><!-- --></A><H3> +isDefine</H3> +<PRE> +public final boolean <B>isDefine</B>()</PRE> +<DL> +<DD>Returns true if this is a define, false if an undefine. +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setIf(java.lang.String)"><!-- --></A><H3> +setIf</H3> +<PRE> +public final void <B>setIf</B>(java.lang.String propName)</PRE> +<DL> +<DD>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. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>propName</CODE> - property name</DL> +</DD> +</DL> +<HR> + +<A NAME="setName(java.lang.String)"><!-- --></A><H3> +setName</H3> +<PRE> +public final void <B>setName</B>(java.lang.String name)</PRE> +<DL> +<DD>Set the name attribute +<P> +<DD><DL> +</DL> +</DD> +</DL> +<HR> + +<A NAME="setUnless(java.lang.String)"><!-- --></A><H3> +setUnless</H3> +<PRE> +public final void <B>setUnless</B>(java.lang.String propName)</PRE> +<DL> +<DD>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. +<P> +<DD><DL> +<DT><B>Parameters:</B><DD><CODE>propName</CODE> - name of property</DL> +</DD> +</DL> +<!-- ========= END OF CLASS DATA ========= --> +<HR> + + +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<A NAME="navbar_bottom"><!-- --></A> +<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> +<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> +<TR> +<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> +<A NAME="navbar_bottom_firstrow"><!-- --></A> +<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> + <TR ALIGN="center" VALIGN="top"> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> + <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/UndefineArgument.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> + <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> + </TR> +</TABLE> +</TD> +<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> +</EM> +</TD> +</TR> + +<TR> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../net/sf/antcontrib/cpptasks/types/SystemLibrarySet.html" title="class in net.sf.antcontrib.cpptasks.types"><B>PREV CLASS</B></A> + NEXT CLASS</FONT></TD> +<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> + <A HREF="../../../../../index.html?net/sf/antcontrib/cpptasks/types/UndefineArgument.html" target="_top"><B>FRAMES</B></A> + <A HREF="UndefineArgument.html" target="_top"><B>NO FRAMES</B></A> + <SCRIPT type="text/javascript"> + <!-- + if(window==top) { + document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); + } + //--> +</SCRIPT> +<NOSCRIPT> + <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> +</NOSCRIPT> + + +</FONT></TD> +</TR> +<TR> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> + SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> +<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> +DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> +</TR> +</TABLE> +<A NAME="skip-navbar_bottom"></A> +<!-- ======== END OF BOTTOM NAVBAR ======= --> + +<HR> +Copyright © 2001-2008 <a href="http://ant-contrib.sourceforge.net">Ant-Contrib Project</a>. All Rights Reserved. +</BODY> +</HTML> |