source: release-kits/lirk3/resources/gs3-release-maker/ant/docs/manual/api/org/apache/tools/ant/types/selectors/SizeSelector.html@ 14982

Last change on this file since 14982 was 14982, checked in by oranfry, 16 years ago

initial import of LiRK3
File size: 31.7 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:34 NZST 2007 -->
6<TITLE>
7SizeSelector (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.selectors.SizeSelector 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="SizeSelector (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/types/selectors/SelectSelector.html" title="class in org.apache.tools.ant.types.selectors"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.ByteUnits.html" title="class in org.apache.tools.ant.types.selectors"><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="SizeSelector.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;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&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;<A HREF="#field_detail">FIELD</A>&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.types.selectors</FONT>
85<BR>
86Class SizeSelector</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">org.apache.tools.ant.ProjectComponent</A>
90 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">org.apache.tools.ant.types.DataType</A>
91 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html" title="class in org.apache.tools.ant.types.selectors">org.apache.tools.ant.types.selectors.BaseSelector</A>
92 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">org.apache.tools.ant.types.selectors.BaseExtendSelector</A>
93 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.selectors.SizeSelector</B>
94</PRE>
95<DL>
96<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/types/selectors/ExtendFileSelector.html" title="interface in org.apache.tools.ant.types.selectors">ExtendFileSelector</A>, <A HREF="../../../../../../org/apache/tools/ant/types/selectors/FileSelector.html" title="interface in org.apache.tools.ant.types.selectors">FileSelector</A>, <A HREF="../../../../../../org/apache/tools/ant/types/Parameterizable.html" title="interface in org.apache.tools.ant.types">Parameterizable</A></DD>
97</DL>
98<HR>
99<DL>
100<DT>public class <B>SizeSelector</B><DT>extends <A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></DL>
101
102<P>
103Selector that filters files based on their size.
104<P>
105
106<P>
107<DL>
108<DT><B>Since:</B></DT>
109 <DD>1.5</DD>
110</DL>
111<HR>
112
113<P>
114<!-- ======== NESTED CLASS SUMMARY ======== -->
115
116<A NAME="nested_class_summary"><!-- --></A>
117<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
118<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
119<TD COLSPAN=2><FONT SIZE="+2">
120<B>Nested Class Summary</B></FONT></TD>
121</TR>
122<TR BGCOLOR="white" CLASS="TableRowColor">
123<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
124<CODE>static&nbsp;class</CODE></FONT></TD>
125<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.ByteUnits.html" title="class in org.apache.tools.ant.types.selectors">SizeSelector.ByteUnits</A></B></CODE>
126
127<BR>
128&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enumerated attribute with the values for units.</TD>
129</TR>
130<TR BGCOLOR="white" CLASS="TableRowColor">
131<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
132<CODE>static&nbsp;class</CODE></FONT></TD>
133<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.SizeComparisons.html" title="class in org.apache.tools.ant.types.selectors">SizeSelector.SizeComparisons</A></B></CODE>
134
135<BR>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Enumerated attribute with the values for size comparison.</TD>
137</TR>
138</TABLE>
139&nbsp;
140<!-- =========== FIELD SUMMARY =========== -->
141
142<A NAME="field_summary"><!-- --></A>
143<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145<TD COLSPAN=2><FONT SIZE="+2">
146<B>Field Summary</B></FONT></TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#SIZE_KEY">SIZE_KEY</A></B></CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for parameterized custom selector</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#UNITS_KEY">UNITS_KEY</A></B></CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for parameterized custom selector</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
167<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#WHEN_KEY">WHEN_KEY</A></B></CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used for parameterized custom selector</TD>
171</TR>
172</TABLE>
173&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.types.selectors.BaseExtendSelector"><!-- --></A>
174<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
175<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
176<TD><B>Fields inherited from class org.apache.tools.ant.types.selectors.<A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></B></TD>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html#parameters">parameters</A></CODE></TD>
180</TR>
181</TABLE>
182&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
185<TD><B>Fields inherited from class org.apache.tools.ant.types.<A HREF="../../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#checked">checked</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#description">description</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#ref">ref</A></CODE></TD>
189</TR>
190</TABLE>
191&nbsp;<A NAME="fields_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
192<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
193<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
194<TD><B>Fields inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#project">project</A></CODE></TD>
198</TR>
199</TABLE>
200&nbsp;
201<!-- ======== CONSTRUCTOR SUMMARY ======== -->
202
203<A NAME="constructor_summary"><!-- --></A>
204<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
205<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
206<TD COLSPAN=2><FONT SIZE="+2">
207<B>Constructor Summary</B></FONT></TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#SizeSelector()">SizeSelector</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new <code>SizeSelector</code> instance.</TD>
214</TR>
215</TABLE>
216&nbsp;
217<!-- ========== METHOD SUMMARY =========== -->
218
219<A NAME="method_summary"><!-- --></A>
220<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
221<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
222<TD COLSPAN=2><FONT SIZE="+2">
223<B>Method Summary</B></FONT></TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227<CODE>&nbsp;boolean</CODE></FONT></TD>
228<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#isSelected(java.io.File, java.lang.String, java.io.File)">isSelected</A></B>(java.io.File&nbsp;basedir,
229 java.lang.String&nbsp;filename,
230 java.io.File&nbsp;file)</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The heart of the matter.</TD>
234</TR>
235<TR BGCOLOR="white" CLASS="TableRowColor">
236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237<CODE>&nbsp;void</CODE></FONT></TD>
238<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#setParameters(org.apache.tools.ant.types.Parameter[])">setParameters</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/Parameter.html" title="class in org.apache.tools.ant.types">Parameter</A>[]&nbsp;parameters)</CODE>
239
240<BR>
241&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When using this as a custom selector, this method will be called.</TD>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245<CODE>&nbsp;void</CODE></FONT></TD>
246<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#setUnits(org.apache.tools.ant.types.selectors.SizeSelector.ByteUnits)">setUnits</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.ByteUnits.html" title="class in org.apache.tools.ant.types.selectors">SizeSelector.ByteUnits</A>&nbsp;units)</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the units to use for the comparison.</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>&nbsp;void</CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#setValue(long)">setValue</A></B>(long&nbsp;size)</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A size selector needs to know what size to base its selecting on.</TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261<CODE>&nbsp;void</CODE></FONT></TD>
262<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#setWhen(org.apache.tools.ant.types.selectors.SizeSelector.SizeComparisons)">setWhen</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.SizeComparisons.html" title="class in org.apache.tools.ant.types.selectors">SizeSelector.SizeComparisons</A>&nbsp;scmp)</CODE>
263
264<BR>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This specifies when the file should be selected, whether it be
266 when the file matches a particular size, when it is smaller,
267 or whether it is larger.</TD>
268</TR>
269<TR BGCOLOR="white" CLASS="TableRowColor">
270<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
271<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
272<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#toString()">toString</A></B>()</CODE>
273
274<BR>
275&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a <code>String</code> object representing the specified
276 SizeSelector.</TD>
277</TR>
278<TR BGCOLOR="white" CLASS="TableRowColor">
279<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
280<CODE>&nbsp;void</CODE></FONT></TD>
281<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.html#verifySettings()">verifySettings</A></B>()</CODE>
282
283<BR>
284&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks to make sure all settings are kosher.</TD>
285</TR>
286</TABLE>
287&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.selectors.BaseExtendSelector"><!-- --></A>
288<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
289<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
290<TD><B>Methods inherited from class org.apache.tools.ant.types.selectors.<A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></B></TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html#getParameters()">getParameters</A></CODE></TD>
294</TR>
295</TABLE>
296&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.selectors.BaseSelector"><!-- --></A>
297<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
298<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
299<TD><B>Methods inherited from class org.apache.tools.ant.types.selectors.<A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseSelector</A></B></TD>
300</TR>
301<TR BGCOLOR="white" CLASS="TableRowColor">
302<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html#getError()">getError</A>, <A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html#setError(java.lang.String)">setError</A>, <A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html#validate()">validate</A></CODE></TD>
303</TR>
304</TABLE>
305&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.types.DataType"><!-- --></A>
306<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
307<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
308<TD><B>Methods inherited from class org.apache.tools.ant.types.<A HREF="../../../../../../org/apache/tools/ant/types/DataType.html" title="class in org.apache.tools.ant.types">DataType</A></B></TD>
309</TR>
310<TR BGCOLOR="white" CLASS="TableRowColor">
311<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#checkAttributesAllowed()">checkAttributesAllowed</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#checkChildrenAllowed()">checkChildrenAllowed</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#circularReference()">circularReference</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#dieOnCircularReference(java.util.Stack, org.apache.tools.ant.Project)">dieOnCircularReference</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#getCheckedRef(java.lang.Class, java.lang.String)">getCheckedRef</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#getDescription()">getDescription</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#getRefid()">getRefid</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#isChecked()">isChecked</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#isReference()">isReference</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#noChildrenAllowed()">noChildrenAllowed</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#setChecked(boolean)">setChecked</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#setRefid(org.apache.tools.ant.types.Reference)">setRefid</A>, <A HREF="../../../../../../org/apache/tools/ant/types/DataType.html#tooManyAttributes()">tooManyAttributes</A></CODE></TD>
312</TR>
313</TABLE>
314&nbsp;<A NAME="methods_inherited_from_class_org.apache.tools.ant.ProjectComponent"><!-- --></A>
315<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
316<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
317<TD><B>Methods inherited from class org.apache.tools.ant.<A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</A></B></TD>
318</TR>
319<TR BGCOLOR="white" CLASS="TableRowColor">
320<TD><CODE><A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#getProject()">getProject</A>, <A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String)">log</A>, <A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#log(java.lang.String, int)">log</A>, <A HREF="../../../../../../org/apache/tools/ant/ProjectComponent.html#setProject(org.apache.tools.ant.Project)">setProject</A></CODE></TD>
321</TR>
322</TABLE>
323&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
324<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
325<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
326<TD><B>Methods inherited from class java.lang.Object</B></TD>
327</TR>
328<TR BGCOLOR="white" CLASS="TableRowColor">
329<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
330</TR>
331</TABLE>
332&nbsp;
333<P>
334
335<!-- ============ FIELD DETAIL =========== -->
336
337<A NAME="field_detail"><!-- --></A>
338<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
339<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
340<TD COLSPAN=1><FONT SIZE="+2">
341<B>Field Detail</B></FONT></TD>
342</TR>
343</TABLE>
344
345<A NAME="SIZE_KEY"><!-- --></A><H3>
346SIZE_KEY</H3>
347<PRE>
348public static final java.lang.String <B>SIZE_KEY</B></PRE>
349<DL>
350<DD>Used for parameterized custom selector
351<P>
352<DL>
353<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.types.selectors.SizeSelector.SIZE_KEY">Constant Field Values</A></DL>
354</DL>
355<HR>
356
357<A NAME="UNITS_KEY"><!-- --></A><H3>
358UNITS_KEY</H3>
359<PRE>
360public static final java.lang.String <B>UNITS_KEY</B></PRE>
361<DL>
362<DD>Used for parameterized custom selector
363<P>
364<DL>
365<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.types.selectors.SizeSelector.UNITS_KEY">Constant Field Values</A></DL>
366</DL>
367<HR>
368
369<A NAME="WHEN_KEY"><!-- --></A><H3>
370WHEN_KEY</H3>
371<PRE>
372public static final java.lang.String <B>WHEN_KEY</B></PRE>
373<DL>
374<DD>Used for parameterized custom selector
375<P>
376<DL>
377<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.types.selectors.SizeSelector.WHEN_KEY">Constant Field Values</A></DL>
378</DL>
379
380<!-- ========= CONSTRUCTOR DETAIL ======== -->
381
382<A NAME="constructor_detail"><!-- --></A>
383<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
384<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
385<TD COLSPAN=1><FONT SIZE="+2">
386<B>Constructor Detail</B></FONT></TD>
387</TR>
388</TABLE>
389
390<A NAME="SizeSelector()"><!-- --></A><H3>
391SizeSelector</H3>
392<PRE>
393public <B>SizeSelector</B>()</PRE>
394<DL>
395<DD>Creates a new <code>SizeSelector</code> instance.
396<P>
397</DL>
398
399<!-- ============ METHOD DETAIL ========== -->
400
401<A NAME="method_detail"><!-- --></A>
402<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
403<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
404<TD COLSPAN=1><FONT SIZE="+2">
405<B>Method Detail</B></FONT></TD>
406</TR>
407</TABLE>
408
409<A NAME="toString()"><!-- --></A><H3>
410toString</H3>
411<PRE>
412public java.lang.String <B>toString</B>()</PRE>
413<DL>
414<DD>Returns a <code>String</code> object representing the specified
415 SizeSelector. This is "{sizeselector value: " + <"compare",
416 "less", "more", "equal"> + "}".
417<P>
418<DD><DL>
419
420<DT><B>Returns:</B><DD>a string describing this object</DL>
421</DD>
422</DL>
423<HR>
424
425<A NAME="setValue(long)"><!-- --></A><H3>
426setValue</H3>
427<PRE>
428public void <B>setValue</B>(long&nbsp;size)</PRE>
429<DL>
430<DD>A size selector needs to know what size to base its selecting on.
431 This will be further modified by the multiplier to get an
432 actual size limit.
433<P>
434<DD><DL>
435<DT><B>Parameters:</B><DD><CODE>size</CODE> - the size to select against expressed in units.</DL>
436</DD>
437</DL>
438<HR>
439
440<A NAME="setUnits(org.apache.tools.ant.types.selectors.SizeSelector.ByteUnits)"><!-- --></A><H3>
441setUnits</H3>
442<PRE>
443public void <B>setUnits</B>(<A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.ByteUnits.html" title="class in org.apache.tools.ant.types.selectors">SizeSelector.ByteUnits</A>&nbsp;units)</PRE>
444<DL>
445<DD>Sets the units to use for the comparison. This is a little
446 complicated because common usage has created standards that
447 play havoc with capitalization rules. Thus, some people will
448 use "K" for indicating 1000's, when the SI standard calls for
449 "k". Others have tried to introduce "K" as a multiple of 1024,
450 but that falls down when you reach "M", since "m" is already
451 defined as 0.001.
452 <p>
453 To get around this complexity, a number of standards bodies
454 have proposed the 2^10 standard, and at least one has adopted
455 it. But we are still left with a populace that isn't clear on
456 how capitalization should work.
457 <p>
458 We therefore ignore capitalization as much as possible.
459 Completely mixed case is not possible, but all upper and lower
460 forms are accepted for all long and short forms. Since we have
461 no need to work with the 0.001 case, this practice works here.
462 <p>
463 This function translates all the long and short forms that a
464 unit prefix can occur in and translates them into a single
465 multiplier.
466<P>
467<DD><DL>
468<DT><B>Parameters:</B><DD><CODE>units</CODE> - The units to compare the size to, using an
469 EnumeratedAttribute.</DL>
470</DD>
471</DL>
472<HR>
473
474<A NAME="setWhen(org.apache.tools.ant.types.selectors.SizeSelector.SizeComparisons)"><!-- --></A><H3>
475setWhen</H3>
476<PRE>
477public void <B>setWhen</B>(<A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.SizeComparisons.html" title="class in org.apache.tools.ant.types.selectors">SizeSelector.SizeComparisons</A>&nbsp;scmp)</PRE>
478<DL>
479<DD>This specifies when the file should be selected, whether it be
480 when the file matches a particular size, when it is smaller,
481 or whether it is larger.
482<P>
483<DD><DL>
484<DT><B>Parameters:</B><DD><CODE>scmp</CODE> - The comparison to perform, an EnumeratedAttribute.</DL>
485</DD>
486</DL>
487<HR>
488
489<A NAME="setParameters(org.apache.tools.ant.types.Parameter[])"><!-- --></A><H3>
490setParameters</H3>
491<PRE>
492public void <B>setParameters</B>(<A HREF="../../../../../../org/apache/tools/ant/types/Parameter.html" title="class in org.apache.tools.ant.types">Parameter</A>[]&nbsp;parameters)</PRE>
493<DL>
494<DD>When using this as a custom selector, this method will be called.
495 It translates each parameter into the appropriate setXXX() call.
496<P>
497<DD><DL>
498<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/Parameterizable.html#setParameters(org.apache.tools.ant.types.Parameter[])">setParameters</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/types/Parameterizable.html" title="interface in org.apache.tools.ant.types">Parameterizable</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html#setParameters(org.apache.tools.ant.types.Parameter[])">setParameters</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></CODE></DL>
499</DD>
500<DD><DL>
501<DT><B>Parameters:</B><DD><CODE>parameters</CODE> - the complete set of parameters for this selector.</DL>
502</DD>
503</DL>
504<HR>
505
506<A NAME="verifySettings()"><!-- --></A><H3>
507verifySettings</H3>
508<PRE>
509public void <B>verifySettings</B>()</PRE>
510<DL>
511<DD><p>Checks to make sure all settings are kosher. In this case, it
512 means that the size attribute has been set (to a positive value),
513 that the multiplier has a valid setting, and that the size limit
514 is valid. Since the latter is a calculated value, this can only
515 fail due to a programming error.
516 </p>
517 <p>If a problem is detected, the setError() method is called.
518 </p>
519<P>
520<DD><DL>
521<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html#verifySettings()">verifySettings</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseSelector</A></CODE></DL>
522</DD>
523<DD><DL>
524</DL>
525</DD>
526</DL>
527<HR>
528
529<A NAME="isSelected(java.io.File, java.lang.String, java.io.File)"><!-- --></A><H3>
530isSelected</H3>
531<PRE>
532public boolean <B>isSelected</B>(java.io.File&nbsp;basedir,
533 java.lang.String&nbsp;filename,
534 java.io.File&nbsp;file)</PRE>
535<DL>
536<DD>The heart of the matter. This is where the selector gets to decide
537 on the inclusion of a file in a particular fileset.
538<P>
539<DD><DL>
540<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FileSelector.html#isSelected(java.io.File, java.lang.String, java.io.File)">isSelected</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/FileSelector.html" title="interface in org.apache.tools.ant.types.selectors">FileSelector</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html#isSelected(java.io.File, java.lang.String, java.io.File)">isSelected</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/tools/ant/types/selectors/BaseExtendSelector.html" title="class in org.apache.tools.ant.types.selectors">BaseExtendSelector</A></CODE></DL>
541</DD>
542<DD><DL>
543<DT><B>Parameters:</B><DD><CODE>basedir</CODE> - A java.io.File object for the base directory.<DD><CODE>filename</CODE> - The name of the file to check.<DD><CODE>file</CODE> - A File object for this filename.
544<DT><B>Returns:</B><DD>whether the file should be selected or not.</DL>
545</DD>
546</DL>
547<!-- ========= END OF CLASS DATA ========= -->
548<HR>
549
550
551<!-- ======= START OF BOTTOM NAVBAR ====== -->
552<A NAME="navbar_bottom"><!-- --></A>
553<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
554<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
555<TR>
556<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
557<A NAME="navbar_bottom_firstrow"><!-- --></A>
558<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
559 <TR ALIGN="center" VALIGN="top">
560 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
561 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
562 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
563 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
564 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
565 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
566 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
567 </TR>
568</TABLE>
569</TD>
570<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
571</EM>
572</TD>
573</TR>
574
575<TR>
576<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
577&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/selectors/SelectSelector.html" title="class in org.apache.tools.ant.types.selectors"><B>PREV CLASS</B></A>&nbsp;
578&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/selectors/SizeSelector.ByteUnits.html" title="class in org.apache.tools.ant.types.selectors"><B>NEXT CLASS</B></A></FONT></TD>
579<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
580 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
581&nbsp;<A HREF="SizeSelector.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
582&nbsp;<SCRIPT type="text/javascript">
583 <!--
584 if(window==top) {
585 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
586 }
587 //-->
588</SCRIPT>
589<NOSCRIPT>
590 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
591</NOSCRIPT>
592
593</FONT></TD>
594</TR>
595<TR>
596<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
597 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
598<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
599DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
600</TR>
601</TABLE>
602<A NAME="skip-navbar_bottom"></A>
603<!-- ======== END OF BOTTOM NAVBAR ======= -->
604
605<HR>
606Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
607</BODY>
608</HTML>
Note: See TracBrowser for help on using the repository browser.