source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/util/depend/AbstractAnalyzer.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: 27.9 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:35 NZST 2007 -->
6<TITLE>
7AbstractAnalyzer (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.util.depend.AbstractAnalyzer 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="AbstractAnalyzer (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;PREV CLASS&nbsp;
53&nbsp;NEXT CLASS</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="AbstractAnalyzer.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;<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.util.depend</FONT>
85<BR>
86Class AbstractAnalyzer</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.util.depend.AbstractAnalyzer</B>
90</PRE>
91<DL>
92<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></DD>
93</DL>
94<DL>
95<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../../org/apache/tools/ant/util/depend/bcel/AncestorAnalyzer.html" title="class in org.apache.tools.ant.util.depend.bcel">AncestorAnalyzer</A>, <A HREF="../../../../../../org/apache/tools/ant/taskdefs/optional/depend/AntAnalyzer.html" title="class in org.apache.tools.ant.taskdefs.optional.depend">AntAnalyzer</A>, <A HREF="../../../../../../org/apache/tools/ant/util/depend/bcel/FullAnalyzer.html" title="class in org.apache.tools.ant.util.depend.bcel">FullAnalyzer</A></DD>
96</DL>
97<HR>
98<DL>
99<DT>public abstract class <B>AbstractAnalyzer</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></DL>
100
101<P>
102An abstract implementation of the analyzer interface providing support
103 for the bulk of interface methods.
104<P>
105
106<P>
107<HR>
108
109<P>
110<!-- ======== NESTED CLASS SUMMARY ======== -->
111
112
113<!-- =========== FIELD SUMMARY =========== -->
114
115<A NAME="field_summary"><!-- --></A>
116<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
117<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
118<TD COLSPAN=2><FONT SIZE="+2">
119<B>Field Summary</B></FONT></TD>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
123<CODE>static&nbsp;int</CODE></FONT></TD>
124<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#MAX_LOOPS">MAX_LOOPS</A></B></CODE>
125
126<BR>
127&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Maximum number of loops for looking for indirect dependencies.</TD>
128</TR>
129</TABLE>
130&nbsp;
131<!-- ======== CONSTRUCTOR SUMMARY ======== -->
132
133<A NAME="constructor_summary"><!-- --></A>
134<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
135<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
136<TD COLSPAN=2><FONT SIZE="+2">
137<B>Constructor Summary</B></FONT></TD>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
141<CODE>protected </CODE></FONT></TD>
142<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#AbstractAnalyzer()">AbstractAnalyzer</A></B>()</CODE>
143
144<BR>
145&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Setup the analyzer</TD>
146</TR>
147</TABLE>
148&nbsp;
149<!-- ========== METHOD SUMMARY =========== -->
150
151<A NAME="method_summary"><!-- --></A>
152<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
153<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
154<TD COLSPAN=2><FONT SIZE="+2">
155<B>Method Summary</B></FONT></TD>
156</TR>
157<TR BGCOLOR="white" CLASS="TableRowColor">
158<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
159<CODE>&nbsp;void</CODE></FONT></TD>
160<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#addClassPath(org.apache.tools.ant.types.Path)">addClassPath</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classPath)</CODE>
161
162<BR>
163&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a classpath to the classpath being used by the analyzer.</TD>
164</TR>
165<TR BGCOLOR="white" CLASS="TableRowColor">
166<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
167<CODE>&nbsp;void</CODE></FONT></TD>
168<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#addRootClass(java.lang.String)">addRootClass</A></B>(java.lang.String&nbsp;className)</CODE>
169
170<BR>
171&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a root class.</TD>
172</TR>
173<TR BGCOLOR="white" CLASS="TableRowColor">
174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
175<CODE>&nbsp;void</CODE></FONT></TD>
176<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#addSourcePath(org.apache.tools.ant.types.Path)">addSourcePath</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;sourcePath)</CODE>
177
178<BR>
179&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Add a source path to the source path used by this analyzer.</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>&nbsp;void</CODE></FONT></TD>
184<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#config(java.lang.String, java.lang.Object)">config</A></B>(java.lang.String&nbsp;name,
185 java.lang.Object&nbsp;info)</CODE>
186
187<BR>
188&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Configure an aspect of the analyzer.</TD>
189</TR>
190<TR BGCOLOR="white" CLASS="TableRowColor">
191<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
192<CODE>protected abstract &nbsp;void</CODE></FONT></TD>
193<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#determineDependencies(java.util.Vector, java.util.Vector)">determineDependencies</A></B>(java.util.Vector&nbsp;files,
194 java.util.Vector&nbsp;classes)</CODE>
195
196<BR>
197&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determine the dependencies of the current set of root classes</TD>
198</TR>
199<TR BGCOLOR="white" CLASS="TableRowColor">
200<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
201<CODE>&nbsp;java.io.File</CODE></FONT></TD>
202<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#getClassContainer(java.lang.String)">getClassContainer</A></B>(java.lang.String&nbsp;classname)</CODE>
203
204<BR>
205&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the file that contains the class definition</TD>
206</TR>
207<TR BGCOLOR="white" CLASS="TableRowColor">
208<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
209<CODE>&nbsp;java.util.Enumeration</CODE></FONT></TD>
210<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#getClassDependencies()">getClassDependencies</A></B>()</CODE>
211
212<BR>
213&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the list of classes upon which root classes depend.</TD>
214</TR>
215<TR BGCOLOR="white" CLASS="TableRowColor">
216<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
217<CODE>&nbsp;java.util.Enumeration</CODE></FONT></TD>
218<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#getFileDependencies()">getFileDependencies</A></B>()</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the list of files in the file system upon which the root classes
222 depend.</TD>
223</TR>
224<TR BGCOLOR="white" CLASS="TableRowColor">
225<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
226<CODE>protected &nbsp;java.util.Enumeration</CODE></FONT></TD>
227<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#getRootClasses()">getRootClasses</A></B>()</CODE>
228
229<BR>
230&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get an enumeration of the root classes</TD>
231</TR>
232<TR BGCOLOR="white" CLASS="TableRowColor">
233<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234<CODE>&nbsp;java.io.File</CODE></FONT></TD>
235<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#getSourceContainer(java.lang.String)">getSourceContainer</A></B>(java.lang.String&nbsp;classname)</CODE>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the file that contains the class source.</TD>
239</TR>
240<TR BGCOLOR="white" CLASS="TableRowColor">
241<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
242<CODE>protected &nbsp;boolean</CODE></FONT></TD>
243<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#isClosureRequired()">isClosureRequired</A></B>()</CODE>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicate if the analyzer is required to follow
247 indirect class relationships.</TD>
248</TR>
249<TR BGCOLOR="white" CLASS="TableRowColor">
250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251<CODE>&nbsp;void</CODE></FONT></TD>
252<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#reset()">reset</A></B>()</CODE>
253
254<BR>
255&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset the dependency list.</TD>
256</TR>
257<TR BGCOLOR="white" CLASS="TableRowColor">
258<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
259<CODE>&nbsp;void</CODE></FONT></TD>
260<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#setClosure(boolean)">setClosure</A></B>(boolean&nbsp;closure)</CODE>
261
262<BR>
263&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the closure flag.</TD>
264</TR>
265<TR BGCOLOR="white" CLASS="TableRowColor">
266<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
267<CODE>protected abstract &nbsp;boolean</CODE></FONT></TD>
268<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/util/depend/AbstractAnalyzer.html#supportsFileDependencies()">supportsFileDependencies</A></B>()</CODE>
269
270<BR>
271&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicate if the particular subclass supports file dependency
272 information.</TD>
273</TR>
274</TABLE>
275&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
276<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
277<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
278<TD><B>Methods inherited from class java.lang.Object</B></TD>
279</TR>
280<TR BGCOLOR="white" CLASS="TableRowColor">
281<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
282</TR>
283</TABLE>
284&nbsp;
285<P>
286
287<!-- ============ FIELD DETAIL =========== -->
288
289<A NAME="field_detail"><!-- --></A>
290<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
291<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
292<TD COLSPAN=1><FONT SIZE="+2">
293<B>Field Detail</B></FONT></TD>
294</TR>
295</TABLE>
296
297<A NAME="MAX_LOOPS"><!-- --></A><H3>
298MAX_LOOPS</H3>
299<PRE>
300public static final int <B>MAX_LOOPS</B></PRE>
301<DL>
302<DD>Maximum number of loops for looking for indirect dependencies.
303<P>
304<DL>
305<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#org.apache.tools.ant.util.depend.AbstractAnalyzer.MAX_LOOPS">Constant Field Values</A></DL>
306</DL>
307
308<!-- ========= CONSTRUCTOR DETAIL ======== -->
309
310<A NAME="constructor_detail"><!-- --></A>
311<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
312<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
313<TD COLSPAN=1><FONT SIZE="+2">
314<B>Constructor Detail</B></FONT></TD>
315</TR>
316</TABLE>
317
318<A NAME="AbstractAnalyzer()"><!-- --></A><H3>
319AbstractAnalyzer</H3>
320<PRE>
321protected <B>AbstractAnalyzer</B>()</PRE>
322<DL>
323<DD>Setup the analyzer
324<P>
325</DL>
326
327<!-- ============ METHOD DETAIL ========== -->
328
329<A NAME="method_detail"><!-- --></A>
330<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
331<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
332<TD COLSPAN=1><FONT SIZE="+2">
333<B>Method Detail</B></FONT></TD>
334</TR>
335</TABLE>
336
337<A NAME="setClosure(boolean)"><!-- --></A><H3>
338setClosure</H3>
339<PRE>
340public void <B>setClosure</B>(boolean&nbsp;closure)</PRE>
341<DL>
342<DD>Set the closure flag. If this flag is true the analyzer will traverse
343 all class relationships until it has collected the entire set of
344 direct and indirect dependencies
345<P>
346<DD><DL>
347<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#setClosure(boolean)">setClosure</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
348</DD>
349<DD><DL>
350<DT><B>Parameters:</B><DD><CODE>closure</CODE> - true if dependencies should be traversed to determine
351 indirect dependencies.</DL>
352</DD>
353</DL>
354<HR>
355
356<A NAME="getFileDependencies()"><!-- --></A><H3>
357getFileDependencies</H3>
358<PRE>
359public java.util.Enumeration <B>getFileDependencies</B>()</PRE>
360<DL>
361<DD>Get the list of files in the file system upon which the root classes
362 depend. The files will be either the classfiles or jar files upon
363 which the root classes depend.
364<P>
365<DD><DL>
366<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#getFileDependencies()">getFileDependencies</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
367</DD>
368<DD><DL>
369
370<DT><B>Returns:</B><DD>an enumeration of File instances.</DL>
371</DD>
372</DL>
373<HR>
374
375<A NAME="getClassDependencies()"><!-- --></A><H3>
376getClassDependencies</H3>
377<PRE>
378public java.util.Enumeration <B>getClassDependencies</B>()</PRE>
379<DL>
380<DD>Get the list of classes upon which root classes depend. This is a
381 list of Java classnames in dot notation.
382<P>
383<DD><DL>
384<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#getClassDependencies()">getClassDependencies</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
385</DD>
386<DD><DL>
387
388<DT><B>Returns:</B><DD>an enumeration of Strings, each being the name of a Java
389 class in dot notation.</DL>
390</DD>
391</DL>
392<HR>
393
394<A NAME="getClassContainer(java.lang.String)"><!-- --></A><H3>
395getClassContainer</H3>
396<PRE>
397public java.io.File <B>getClassContainer</B>(java.lang.String&nbsp;classname)
398 throws java.io.IOException</PRE>
399<DL>
400<DD>Get the file that contains the class definition
401<P>
402<DD><DL>
403<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#getClassContainer(java.lang.String)">getClassContainer</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
404</DD>
405<DD><DL>
406<DT><B>Parameters:</B><DD><CODE>classname</CODE> - the name of the required class
407<DT><B>Returns:</B><DD>the file instance, zip or class, containing the
408 class or null if the class could not be found.
409<DT><B>Throws:</B>
410<DD><CODE>java.io.IOException</CODE> - if the files in the classpath cannot be read.</DL>
411</DD>
412</DL>
413<HR>
414
415<A NAME="getSourceContainer(java.lang.String)"><!-- --></A><H3>
416getSourceContainer</H3>
417<PRE>
418public java.io.File <B>getSourceContainer</B>(java.lang.String&nbsp;classname)
419 throws java.io.IOException</PRE>
420<DL>
421<DD>Get the file that contains the class source.
422<P>
423<DD><DL>
424<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#getSourceContainer(java.lang.String)">getSourceContainer</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
425</DD>
426<DD><DL>
427<DT><B>Parameters:</B><DD><CODE>classname</CODE> - the name of the required class
428<DT><B>Returns:</B><DD>the file instance, zip or java, containing the
429 source or null if the source for the class could not be found.
430<DT><B>Throws:</B>
431<DD><CODE>java.io.IOException</CODE> - if the files in the sourcepath cannot be read.</DL>
432</DD>
433</DL>
434<HR>
435
436<A NAME="addSourcePath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
437addSourcePath</H3>
438<PRE>
439public void <B>addSourcePath</B>(<A HREF="../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;sourcePath)</PRE>
440<DL>
441<DD>Add a source path to the source path used by this analyzer. The
442 elements in the given path contain the source files for the classes
443 being analyzed. Not all analyzers will use this information.
444<P>
445<DD><DL>
446<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#addSourcePath(org.apache.tools.ant.types.Path)">addSourcePath</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
447</DD>
448<DD><DL>
449<DT><B>Parameters:</B><DD><CODE>sourcePath</CODE> - The Path instance specifying the source path
450 elements.</DL>
451</DD>
452</DL>
453<HR>
454
455<A NAME="addClassPath(org.apache.tools.ant.types.Path)"><!-- --></A><H3>
456addClassPath</H3>
457<PRE>
458public void <B>addClassPath</B>(<A HREF="../../../../../../org/apache/tools/ant/types/Path.html" title="class in org.apache.tools.ant.types">Path</A>&nbsp;classPath)</PRE>
459<DL>
460<DD>Add a classpath to the classpath being used by the analyzer. The
461 classpath contains the binary classfiles for the classes being
462 analyzed The elements may either be the directories or jar files.Not
463 all analyzers will use this information.
464<P>
465<DD><DL>
466<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#addClassPath(org.apache.tools.ant.types.Path)">addClassPath</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
467</DD>
468<DD><DL>
469<DT><B>Parameters:</B><DD><CODE>classPath</CODE> - the Path instance specifying the classpath elements</DL>
470</DD>
471</DL>
472<HR>
473
474<A NAME="addRootClass(java.lang.String)"><!-- --></A><H3>
475addRootClass</H3>
476<PRE>
477public void <B>addRootClass</B>(java.lang.String&nbsp;className)</PRE>
478<DL>
479<DD>Add a root class. The root classes are used to drive the
480 determination of dependency information. The analyzer will start at
481 the root classes and add dependencies from there.
482<P>
483<DD><DL>
484<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#addRootClass(java.lang.String)">addRootClass</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
485</DD>
486<DD><DL>
487<DT><B>Parameters:</B><DD><CODE>className</CODE> - the name of the class in Java dot notation.</DL>
488</DD>
489</DL>
490<HR>
491
492<A NAME="config(java.lang.String, java.lang.Object)"><!-- --></A><H3>
493config</H3>
494<PRE>
495public void <B>config</B>(java.lang.String&nbsp;name,
496 java.lang.Object&nbsp;info)</PRE>
497<DL>
498<DD>Configure an aspect of the analyzer. The set of aspects that are
499 supported is specific to each analyzer instance.
500<P>
501<DD><DL>
502<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#config(java.lang.String, java.lang.Object)">config</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
503</DD>
504<DD><DL>
505<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the aspect being configured<DD><CODE>info</CODE> - the configuration info.</DL>
506</DD>
507</DL>
508<HR>
509
510<A NAME="reset()"><!-- --></A><H3>
511reset</H3>
512<PRE>
513public void <B>reset</B>()</PRE>
514<DL>
515<DD>Reset the dependency list. This will reset the determined
516 dependencies and the also list of root classes.
517<P>
518<DD><DL>
519<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/tools/ant/util/depend/DependencyAnalyzer.html" title="interface in org.apache.tools.ant.util.depend">DependencyAnalyzer</A></CODE></DL>
520</DD>
521<DD><DL>
522</DL>
523</DD>
524</DL>
525<HR>
526
527<A NAME="getRootClasses()"><!-- --></A><H3>
528getRootClasses</H3>
529<PRE>
530protected java.util.Enumeration <B>getRootClasses</B>()</PRE>
531<DL>
532<DD>Get an enumeration of the root classes
533<P>
534<DD><DL>
535</DL>
536</DD>
537<DD><DL>
538
539<DT><B>Returns:</B><DD>an enumeration of Strings, each of which is a class name
540 for a root class.</DL>
541</DD>
542</DL>
543<HR>
544
545<A NAME="isClosureRequired()"><!-- --></A><H3>
546isClosureRequired</H3>
547<PRE>
548protected boolean <B>isClosureRequired</B>()</PRE>
549<DL>
550<DD>Indicate if the analyzer is required to follow
551 indirect class relationships.
552<P>
553<DD><DL>
554</DL>
555</DD>
556<DD><DL>
557
558<DT><B>Returns:</B><DD>true if indirect relationships should be followed.</DL>
559</DD>
560</DL>
561<HR>
562
563<A NAME="determineDependencies(java.util.Vector, java.util.Vector)"><!-- --></A><H3>
564determineDependencies</H3>
565<PRE>
566protected abstract void <B>determineDependencies</B>(java.util.Vector&nbsp;files,
567 java.util.Vector&nbsp;classes)</PRE>
568<DL>
569<DD>Determine the dependencies of the current set of root classes
570<P>
571<DD><DL>
572</DL>
573</DD>
574<DD><DL>
575<DT><B>Parameters:</B><DD><CODE>files</CODE> - a vector into which Files upon which the root classes
576 depend should be placed.<DD><CODE>classes</CODE> - a vector of Strings into which the names of classes
577 upon which the root classes depend should be placed.</DL>
578</DD>
579</DL>
580<HR>
581
582<A NAME="supportsFileDependencies()"><!-- --></A><H3>
583supportsFileDependencies</H3>
584<PRE>
585protected abstract boolean <B>supportsFileDependencies</B>()</PRE>
586<DL>
587<DD>Indicate if the particular subclass supports file dependency
588 information.
589<P>
590<DD><DL>
591</DL>
592</DD>
593<DD><DL>
594
595<DT><B>Returns:</B><DD>true if file dependencies are supported.</DL>
596</DD>
597</DL>
598<!-- ========= END OF CLASS DATA ========= -->
599<HR>
600
601
602<!-- ======= START OF BOTTOM NAVBAR ====== -->
603<A NAME="navbar_bottom"><!-- --></A>
604<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
605<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
606<TR>
607<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
608<A NAME="navbar_bottom_firstrow"><!-- --></A>
609<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
610 <TR ALIGN="center" VALIGN="top">
611 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
612 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
613 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
614 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
615 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
616 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
617 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
618 </TR>
619</TABLE>
620</TD>
621<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
622</EM>
623</TD>
624</TR>
625
626<TR>
627<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
628&nbsp;PREV CLASS&nbsp;
629&nbsp;NEXT CLASS</FONT></TD>
630<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
631 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
632&nbsp;<A HREF="AbstractAnalyzer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
633&nbsp;<SCRIPT type="text/javascript">
634 <!--
635 if(window==top) {
636 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
637 }
638 //-->
639</SCRIPT>
640<NOSCRIPT>
641 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
642</NOSCRIPT>
643
644</FONT></TD>
645</TR>
646<TR>
647<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
648 SUMMARY:&nbsp;NESTED&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>
649<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
650DETAIL:&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>
651</TR>
652</TABLE>
653<A NAME="skip-navbar_bottom"></A>
654<!-- ======== END OF BOTTOM NAVBAR ======= -->
655
656<HR>
657Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
658</BODY>
659</HTML>
Note: See TracBrowser for help on using the repository browser.