source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.html@ 14627

Last change on this file since 14627 was 14627, checked in by oranfry, 17 years ago

initial import of the gs3-release-maker
File size: 14.5 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.4.2_13) on Mon Oct 01 14:33:25 NZST 2007 -->
6<TITLE>
7DotnetDefine (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.optional.dotnet.DotnetDefine class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="DotnetDefine (Apache Ant API)";
18}
19</SCRIPT>
20
21</HEAD>
22
23<BODY BGCOLOR="white" onload="windowTitle();">
24
25
26<!-- ========= START OF TOP NAVBAR ======= -->
27<A NAME="navbar_top"><!-- --></A>
28<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
29<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
30<TR>
31<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
32<A NAME="navbar_top_firstrow"><!-- --></A>
33<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
34 <TR ALIGN="center" VALIGN="top">
35 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
42 </TR>
43</TABLE>
44</TD>
45<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
46</EM>
47</TD>
48</TR>
49
50<TR>
51<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
52&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.TargetTypes.html" title="class in org.apache.tools.ant.taskdefs.optional.dotnet"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetResource.html" title="class in org.apache.tools.ant.taskdefs.optional.dotnet"><B>NEXT CLASS</B></A></FONT></TD>
54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
55 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
56&nbsp;<A HREF="DotnetDefine.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
57&nbsp;<SCRIPT type="text/javascript">
58 <!--
59 if(window==top) {
60 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
61 }
62 //-->
63</SCRIPT>
64<NOSCRIPT>
65 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
66</NOSCRIPT>
67
68</FONT></TD>
69</TR>
70<TR>
71<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
72 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
75</TR>
76</TABLE>
77<A NAME="skip-navbar_top"></A>
78<!-- ========= END OF TOP NAVBAR ========= -->
79
80<HR>
81<!-- ======== START OF CLASS DATA ======== -->
82<H2>
83<FONT SIZE="-1">
84org.apache.tools.ant.taskdefs.optional.dotnet</FONT>
85<BR>
86Class DotnetDefine</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.optional.dotnet.DotnetDefine</B>
90</PRE>
91<HR>
92<DL>
93<DT>public class <B>DotnetDefine</B><DT>extends java.lang.Object</DL>
94
95<P>
96definitions can be conditional. What .NET conditions can not be
97 is in any state other than defined and undefined; you cannot give
98 a definition a value.
99<P>
100
101<P>
102<HR>
103
104<P>
105<!-- ======== NESTED CLASS SUMMARY ======== -->
106
107
108<!-- =========== FIELD SUMMARY =========== -->
109
110
111<!-- ======== CONSTRUCTOR SUMMARY ======== -->
112
113<A NAME="constructor_summary"><!-- --></A>
114<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
115<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
116<TD COLSPAN=2><FONT SIZE="+2">
117<B>Constructor Summary</B></FONT></TD>
118</TR>
119<TR BGCOLOR="white" CLASS="TableRowColor">
120<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.html#DotnetDefine()">DotnetDefine</A></B>()</CODE>
121
122<BR>
123&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
124</TR>
125</TABLE>
126&nbsp;
127<!-- ========== METHOD SUMMARY =========== -->
128
129<A NAME="method_summary"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
132<TD COLSPAN=2><FONT SIZE="+2">
133<B>Method Summary</B></FONT></TD>
134</TR>
135<TR BGCOLOR="white" CLASS="TableRowColor">
136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
137<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
138<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.html#getName()">getName</A></B>()</CODE>
139
140<BR>
141&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
142</TR>
143<TR BGCOLOR="white" CLASS="TableRowColor">
144<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
145<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
146<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.html#getValue(org.apache.tools.ant.Task)">getValue</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>&nbsp;owner)</CODE>
147
148<BR>
149&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method gets the value of this definition.</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
153<CODE>&nbsp;boolean</CODE></FONT></TD>
154<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.html#isSet(org.apache.tools.ant.Task)">isSet</A></B>(<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>&nbsp;owner)</CODE>
155
156<BR>
157&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;logic taken from patternset</TD>
158</TR>
159<TR BGCOLOR="white" CLASS="TableRowColor">
160<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
161<CODE>&nbsp;void</CODE></FONT></TD>
162<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.html#setIf(java.lang.String)">setIf</A></B>(java.lang.String&nbsp;condition)</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the name of a property which must be defined for
166 the definition to be set.</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;void</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.html#setName(java.lang.String)">setName</A></B>(java.lang.String&nbsp;name)</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the name of the definition.</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;void</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetDefine.html#setUnless(java.lang.String)">setUnless</A></B>(java.lang.String&nbsp;condition)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the name of a property which must be undefined for
183 the definition to be set.</TD>
184</TR>
185</TABLE>
186&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
187<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
188<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
189<TD><B>Methods inherited from class java.lang.Object</B></TD>
190</TR>
191<TR BGCOLOR="white" CLASS="TableRowColor">
192<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
193</TR>
194</TABLE>
195&nbsp;
196<P>
197
198<!-- ============ FIELD DETAIL =========== -->
199
200
201<!-- ========= CONSTRUCTOR DETAIL ======== -->
202
203<A NAME="constructor_detail"><!-- --></A>
204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
206<TD COLSPAN=1><FONT SIZE="+2">
207<B>Constructor Detail</B></FONT></TD>
208</TR>
209</TABLE>
210
211<A NAME="DotnetDefine()"><!-- --></A><H3>
212DotnetDefine</H3>
213<PRE>
214public <B>DotnetDefine</B>()</PRE>
215<DL>
216</DL>
217
218<!-- ============ METHOD DETAIL ========== -->
219
220<A NAME="method_detail"><!-- --></A>
221<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
222<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
223<TD COLSPAN=1><FONT SIZE="+2">
224<B>Method Detail</B></FONT></TD>
225</TR>
226</TABLE>
227
228<A NAME="setIf(java.lang.String)"><!-- --></A><H3>
229setIf</H3>
230<PRE>
231public void <B>setIf</B>(java.lang.String&nbsp;condition)</PRE>
232<DL>
233<DD>the name of a property which must be defined for
234 the definition to be set. Optional.
235<P>
236<DD><DL>
237<DT><B>Parameters:</B><DD><CODE>condition</CODE> - the name of the property</DL>
238</DD>
239</DL>
240<HR>
241
242<A NAME="setUnless(java.lang.String)"><!-- --></A><H3>
243setUnless</H3>
244<PRE>
245public void <B>setUnless</B>(java.lang.String&nbsp;condition)</PRE>
246<DL>
247<DD>the name of a property which must be undefined for
248 the definition to be set. Optional.
249<P>
250<DD><DL>
251<DT><B>Parameters:</B><DD><CODE>condition</CODE> - the name of the property</DL>
252</DD>
253</DL>
254<HR>
255
256<A NAME="getName()"><!-- --></A><H3>
257getName</H3>
258<PRE>
259public java.lang.String <B>getName</B>()</PRE>
260<DL>
261<DD><DL>
262</DL>
263</DD>
264</DL>
265<HR>
266
267<A NAME="setName(java.lang.String)"><!-- --></A><H3>
268setName</H3>
269<PRE>
270public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
271<DL>
272<DD>the name of the definition. Required.
273<P>
274<DD><DL>
275<DT><B>Parameters:</B><DD><CODE>name</CODE> - </DL>
276</DD>
277</DL>
278<HR>
279
280<A NAME="getValue(org.apache.tools.ant.Task)"><!-- --></A><H3>
281getValue</H3>
282<PRE>
283public java.lang.String <B>getValue</B>(<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>&nbsp;owner)
284 throws <A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
285<DL>
286<DD>This method gets the value of this definition. Will be null if a condition
287 was declared and not met
288<P>
289<DD><DL>
290<DT><B>Parameters:</B><DD><CODE>owner</CODE> - owning task
291<DT><B>Returns:</B><DD>The value of the definition.
292<DT><B>Throws:</B>
293<DD><CODE><A HREF="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE></DL>
294</DD>
295</DL>
296<HR>
297
298<A NAME="isSet(org.apache.tools.ant.Task)"><!-- --></A><H3>
299isSet</H3>
300<PRE>
301public boolean <B>isSet</B>(<A HREF="../../../../../../../org/apache/tools/ant/Task.html" title="class in org.apache.tools.ant">Task</A>&nbsp;owner)</PRE>
302<DL>
303<DD>logic taken from patternset
304<P>
305<DD><DL>
306<DT><B>Parameters:</B><DD><CODE>owner</CODE> -
307<DT><B>Returns:</B><DD>true if the condition is valid</DL>
308</DD>
309</DL>
310<!-- ========= END OF CLASS DATA ========= -->
311<HR>
312
313
314<!-- ======= START OF BOTTOM NAVBAR ====== -->
315<A NAME="navbar_bottom"><!-- --></A>
316<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
317<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
318<TR>
319<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
320<A NAME="navbar_bottom_firstrow"><!-- --></A>
321<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
322 <TR ALIGN="center" VALIGN="top">
323 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
324 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
325 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
326 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
327 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
328 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
329 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
330 </TR>
331</TABLE>
332</TD>
333<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
334</EM>
335</TD>
336</TR>
337
338<TR>
339<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
340&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetCompile.TargetTypes.html" title="class in org.apache.tools.ant.taskdefs.optional.dotnet"><B>PREV CLASS</B></A>&nbsp;
341&nbsp;<A HREF="../../../../../../../org/apache/tools/ant/taskdefs/optional/dotnet/DotnetResource.html" title="class in org.apache.tools.ant.taskdefs.optional.dotnet"><B>NEXT CLASS</B></A></FONT></TD>
342<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
343 <A HREF="../../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
344&nbsp;<A HREF="DotnetDefine.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
345&nbsp;<SCRIPT type="text/javascript">
346 <!--
347 if(window==top) {
348 document.writeln('<A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
349 }
350 //-->
351</SCRIPT>
352<NOSCRIPT>
353 <A HREF="../../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
354</NOSCRIPT>
355
356</FONT></TD>
357</TR>
358<TR>
359<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
360 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
361<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
362DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
363</TR>
364</TABLE>
365<A NAME="skip-navbar_bottom"></A>
366<!-- ======== END OF BOTTOM NAVBAR ======= -->
367
368<HR>
369Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
370</BODY>
371</HTML>
Note: See TracBrowser for help on using the repository browser.