source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/taskdefs/condition/Equals.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: 13.8 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:23 NZST 2007 -->
6<TITLE>
7Equals (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.taskdefs.condition.Equals 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="Equals (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/condition/Contains.html" title="class in org.apache.tools.ant.taskdefs.condition"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/FilesMatch.html" title="class in org.apache.tools.ant.taskdefs.condition"><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="Equals.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.condition</FONT>
85<BR>
86Class Equals</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.taskdefs.condition.Equals</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>Equals</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</A></DL>
97
98<P>
99Simple String comparison condition.
100<P>
101
102<P>
103<DL>
104<DT><B>Since:</B></DT>
105 <DD>Ant 1.4</DD>
106</DL>
107<HR>
108
109<P>
110<!-- ======== NESTED CLASS SUMMARY ======== -->
111
112
113<!-- =========== FIELD SUMMARY =========== -->
114
115
116<!-- ======== CONSTRUCTOR SUMMARY ======== -->
117
118<A NAME="constructor_summary"><!-- --></A>
119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121<TD COLSPAN=2><FONT SIZE="+2">
122<B>Constructor Summary</B></FONT></TD>
123</TR>
124<TR BGCOLOR="white" CLASS="TableRowColor">
125<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Equals.html#Equals()">Equals</A></B>()</CODE>
126
127<BR>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
129</TR>
130</TABLE>
131&nbsp;
132<!-- ========== METHOD SUMMARY =========== -->
133
134<A NAME="method_summary"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
137<TD COLSPAN=2><FONT SIZE="+2">
138<B>Method Summary</B></FONT></TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<CODE>&nbsp;boolean</CODE></FONT></TD>
143<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Equals.html#eval()">eval</A></B>()</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Is this condition true?</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>&nbsp;void</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Equals.html#setArg1(java.lang.String)">setArg1</A></B>(java.lang.String&nbsp;a1)</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the first string</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>&nbsp;void</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Equals.html#setArg2(java.lang.String)">setArg2</A></B>(java.lang.String&nbsp;a2)</CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the second string</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>&nbsp;void</CODE></FONT></TD>
167<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Equals.html#setCasesensitive(boolean)">setCasesensitive</A></B>(boolean&nbsp;b)</CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should the comparison be case sensitive?</TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>&nbsp;void</CODE></FONT></TD>
175<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Equals.html#setTrim(boolean)">setTrim</A></B>(boolean&nbsp;b)</CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Should we want to trim the arguments before comparing them?</TD>
179</TR>
180</TABLE>
181&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
182<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
183<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
184<TD><B>Methods inherited from class java.lang.Object</B></TD>
185</TR>
186<TR BGCOLOR="white" CLASS="TableRowColor">
187<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
188</TR>
189</TABLE>
190&nbsp;
191<P>
192
193<!-- ============ FIELD DETAIL =========== -->
194
195
196<!-- ========= CONSTRUCTOR DETAIL ======== -->
197
198<A NAME="constructor_detail"><!-- --></A>
199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
200<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
201<TD COLSPAN=1><FONT SIZE="+2">
202<B>Constructor Detail</B></FONT></TD>
203</TR>
204</TABLE>
205
206<A NAME="Equals()"><!-- --></A><H3>
207Equals</H3>
208<PRE>
209public <B>Equals</B>()</PRE>
210<DL>
211</DL>
212
213<!-- ============ METHOD DETAIL ========== -->
214
215<A NAME="method_detail"><!-- --></A>
216<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
217<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
218<TD COLSPAN=1><FONT SIZE="+2">
219<B>Method Detail</B></FONT></TD>
220</TR>
221</TABLE>
222
223<A NAME="setArg1(java.lang.String)"><!-- --></A><H3>
224setArg1</H3>
225<PRE>
226public void <B>setArg1</B>(java.lang.String&nbsp;a1)</PRE>
227<DL>
228<DD>Set the first string
229<P>
230<DD><DL>
231</DL>
232</DD>
233<DD><DL>
234<DT><B>Parameters:</B><DD><CODE>a1</CODE> - the first string</DL>
235</DD>
236</DL>
237<HR>
238
239<A NAME="setArg2(java.lang.String)"><!-- --></A><H3>
240setArg2</H3>
241<PRE>
242public void <B>setArg2</B>(java.lang.String&nbsp;a2)</PRE>
243<DL>
244<DD>Set the second string
245<P>
246<DD><DL>
247</DL>
248</DD>
249<DD><DL>
250<DT><B>Parameters:</B><DD><CODE>a2</CODE> - the second string</DL>
251</DD>
252</DL>
253<HR>
254
255<A NAME="setTrim(boolean)"><!-- --></A><H3>
256setTrim</H3>
257<PRE>
258public void <B>setTrim</B>(boolean&nbsp;b)</PRE>
259<DL>
260<DD>Should we want to trim the arguments before comparing them?
261<P>
262<DD><DL>
263</DL>
264</DD>
265<DD><DL>
266<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true trim the arguments<DT><B>Since:</B></DT>
267 <DD>Ant 1.5</DD>
268</DL>
269</DD>
270</DL>
271<HR>
272
273<A NAME="setCasesensitive(boolean)"><!-- --></A><H3>
274setCasesensitive</H3>
275<PRE>
276public void <B>setCasesensitive</B>(boolean&nbsp;b)</PRE>
277<DL>
278<DD>Should the comparison be case sensitive?
279<P>
280<DD><DL>
281</DL>
282</DD>
283<DD><DL>
284<DT><B>Parameters:</B><DD><CODE>b</CODE> - if true use a case sensitive comparison (this is the
285 default)<DT><B>Since:</B></DT>
286 <DD>Ant 1.5</DD>
287</DL>
288</DD>
289</DL>
290<HR>
291
292<A NAME="eval()"><!-- --></A><H3>
293eval</H3>
294<PRE>
295public boolean <B>eval</B>()
296 throws <A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></PRE>
297<DL>
298<DD><B>Description copied from interface: <CODE><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</A></CODE></B></DD>
299<DD>Is this condition true?
300<P>
301<DD><DL>
302<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html#eval()">eval</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Condition.html" title="interface in org.apache.tools.ant.taskdefs.condition">Condition</A></CODE></DL>
303</DD>
304<DD><DL>
305
306<DT><B>Returns:</B><DD>true if the two strings are equal
307<DT><B>Throws:</B>
308<DD><CODE><A HREF="../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</A></CODE> - if the attributes are not set correctly</DL>
309</DD>
310</DL>
311<!-- ========= END OF CLASS DATA ========= -->
312<HR>
313
314
315<!-- ======= START OF BOTTOM NAVBAR ====== -->
316<A NAME="navbar_bottom"><!-- --></A>
317<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
318<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
319<TR>
320<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
321<A NAME="navbar_bottom_firstrow"><!-- --></A>
322<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
323 <TR ALIGN="center" VALIGN="top">
324 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
325 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
326 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
327 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
328 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
329 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
330 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
331 </TR>
332</TABLE>
333</TD>
334<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
335</EM>
336</TD>
337</TR>
338
339<TR>
340<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
341&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/Contains.html" title="class in org.apache.tools.ant.taskdefs.condition"><B>PREV CLASS</B></A>&nbsp;
342&nbsp;<A HREF="../../../../../../org/apache/tools/ant/taskdefs/condition/FilesMatch.html" title="class in org.apache.tools.ant.taskdefs.condition"><B>NEXT CLASS</B></A></FONT></TD>
343<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
344 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
345&nbsp;<A HREF="Equals.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
346&nbsp;<SCRIPT type="text/javascript">
347 <!--
348 if(window==top) {
349 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
350 }
351 //-->
352</SCRIPT>
353<NOSCRIPT>
354 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
355</NOSCRIPT>
356
357</FONT></TD>
358</TR>
359<TR>
360<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
361 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
362<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
363DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
364</TR>
365</TABLE>
366<A NAME="skip-navbar_bottom"></A>
367<!-- ======== END OF BOTTOM NAVBAR ======= -->
368
369<HR>
370Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
371</BODY>
372</HTML>
Note: See TracBrowser for help on using the repository browser.