source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/types/resolver/ApacheCatalog.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.0 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:33 NZST 2007 -->
6<TITLE>
7ApacheCatalog (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.resolver.ApacheCatalog 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="ApacheCatalog (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;<A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html" title="class in org.apache.tools.ant.types.resolver"><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="ApacheCatalog.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.types.resolver</FONT>
85<BR>
86Class ApacheCatalog</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by">Catalog
90 <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.resolver.ApacheCatalog</B>
91</PRE>
92<HR>
93<DL>
94<DT>public class <B>ApacheCatalog</B><DT>extends Catalog</DL>
95
96<P>
97This class extends the Catalog class provided by Norman Walsh's
98 resolver library in xml-commons in order to add classpath entity
99 and URI resolution. Since XMLCatalog already does classpath
100 resolution, we simply add all CatalogEntry instances back to the
101 controlling XMLCatalog instance. This is done via a callback
102 mechanism. ApacheCatalog is <em>only</em> used for external
103 catalog files. Inline entries (currently <code>&lt;dtd&gt;</code>
104 and <code>&lt;entity&gt;</code>) are not added to ApacheCatalog.
105 See XMLCatalog.java for the details of the entity and URI
106 resolution algorithms.
107<P>
108
109<P>
110<DL>
111<DT><B>Since:</B></DT>
112 <DD>Ant 1.6</DD>
113<DT><B>See Also:</B><DD><CODE>XMLCatalog.CatalogResolver</CODE>,
114<A HREF="../../../../../../serialized-form.html#org.apache.tools.ant.types.resolver.ApacheCatalog">Serialized Form</A></DL>
115<HR>
116
117<P>
118<!-- ======== NESTED CLASS SUMMARY ======== -->
119
120
121<!-- =========== FIELD SUMMARY =========== -->
122
123
124<!-- ======== CONSTRUCTOR SUMMARY ======== -->
125
126<A NAME="constructor_summary"><!-- --></A>
127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
129<TD COLSPAN=2><FONT SIZE="+2">
130<B>Constructor Summary</B></FONT></TD>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalog.html#ApacheCatalog()">ApacheCatalog</A></B>()</CODE>
134
135<BR>
136&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
137</TR>
138</TABLE>
139&nbsp;
140<!-- ========== METHOD SUMMARY =========== -->
141
142<A NAME="method_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>Method 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>&nbsp;void</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalog.html#addEntry(CatalogEntry)">addEntry</A></B>(CatalogEntry&nbsp;entry)</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method overrides the superclass method of the same name
155 in order to add catalog entries back to the controlling
156 XMLCatalog instance.</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>protected &nbsp;Catalog</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalog.html#newCatalog()">newCatalog</A></B>()</CODE>
162
163<BR>
164&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a new ApacheCatalog instance.</TD>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>&nbsp;void</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalog.html#setResolver(org.apache.tools.ant.types.resolver.ApacheCatalogResolver)">setResolver</A></B>(<A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html" title="class in org.apache.tools.ant.types.resolver">ApacheCatalogResolver</A>&nbsp;resolver)</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the resolver object to callback.</TD>
173</TR>
174</TABLE>
175&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
176<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
178<TD><B>Methods inherited from class java.lang.Object</B></TD>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
182</TR>
183</TABLE>
184&nbsp;
185<P>
186
187<!-- ============ FIELD DETAIL =========== -->
188
189
190<!-- ========= CONSTRUCTOR DETAIL ======== -->
191
192<A NAME="constructor_detail"><!-- --></A>
193<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
194<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
195<TD COLSPAN=1><FONT SIZE="+2">
196<B>Constructor Detail</B></FONT></TD>
197</TR>
198</TABLE>
199
200<A NAME="ApacheCatalog()"><!-- --></A><H3>
201ApacheCatalog</H3>
202<PRE>
203public <B>ApacheCatalog</B>()</PRE>
204<DL>
205</DL>
206
207<!-- ============ METHOD DETAIL ========== -->
208
209<A NAME="method_detail"><!-- --></A>
210<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
211<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
212<TD COLSPAN=1><FONT SIZE="+2">
213<B>Method Detail</B></FONT></TD>
214</TR>
215</TABLE>
216
217<A NAME="newCatalog()"><!-- --></A><H3>
218newCatalog</H3>
219<PRE>
220protected Catalog <B>newCatalog</B>()</PRE>
221<DL>
222<DD><p>Create a new ApacheCatalog instance.</p>
223
224 <p>This method overrides the superclass method of the same name
225 in order to set the resolver object for callbacks. The reason
226 we have to do this is that internally Catalog creates a new
227 instance of itself for each external catalog file processed.
228 That is, if two external catalog files are processed, there
229 will be a total of two ApacheCatalog instances, and so on.</p>
230<P>
231<DD><DL>
232</DL>
233</DD>
234</DL>
235<HR>
236
237<A NAME="setResolver(org.apache.tools.ant.types.resolver.ApacheCatalogResolver)"><!-- --></A><H3>
238setResolver</H3>
239<PRE>
240public void <B>setResolver</B>(<A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html" title="class in org.apache.tools.ant.types.resolver">ApacheCatalogResolver</A>&nbsp;resolver)</PRE>
241<DL>
242<DD>Set the resolver object to callback.
243<P>
244<DD><DL>
245</DL>
246</DD>
247</DL>
248<HR>
249
250<A NAME="addEntry(CatalogEntry)"><!-- --></A><H3>
251addEntry</H3>
252<PRE>
253public void <B>addEntry</B>(CatalogEntry&nbsp;entry)</PRE>
254<DL>
255<DD><p>This method overrides the superclass method of the same name
256 in order to add catalog entries back to the controlling
257 XMLCatalog instance. In this way, we can add classpath lookup
258 for these entries.</p>
259
260 <p>When we add an external catalog file, the entries inside it
261 get parsed by this method. Therefore, we override it to add
262 each of them back to the controlling XMLCatalog instance. This
263 is done by performing a callback to the ApacheCatalogResolver,
264 which in turn calls the XMLCatalog.</p>
265
266 <p>XMLCatalog currently only understands <code>PUBLIC</code>
267 and <code>URI</code> entry types, so we ignore the other types.</p>
268<P>
269<DD><DL>
270<DT><B>Parameters:</B><DD><CODE>entry</CODE> - The CatalogEntry to process.</DL>
271</DD>
272</DL>
273<!-- ========= END OF CLASS DATA ========= -->
274<HR>
275
276
277<!-- ======= START OF BOTTOM NAVBAR ====== -->
278<A NAME="navbar_bottom"><!-- --></A>
279<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
280<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
281<TR>
282<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
283<A NAME="navbar_bottom_firstrow"><!-- --></A>
284<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
285 <TR ALIGN="center" VALIGN="top">
286 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
288 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
289 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
290 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
291 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
292 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
293 </TR>
294</TABLE>
295</TD>
296<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
297</EM>
298</TD>
299</TR>
300
301<TR>
302<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
303&nbsp;PREV CLASS&nbsp;
304&nbsp;<A HREF="../../../../../../org/apache/tools/ant/types/resolver/ApacheCatalogResolver.html" title="class in org.apache.tools.ant.types.resolver"><B>NEXT CLASS</B></A></FONT></TD>
305<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
306 <A HREF="../../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
307&nbsp;<A HREF="ApacheCatalog.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
308&nbsp;<SCRIPT type="text/javascript">
309 <!--
310 if(window==top) {
311 document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
312 }
313 //-->
314</SCRIPT>
315<NOSCRIPT>
316 <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
317</NOSCRIPT>
318
319</FONT></TD>
320</TR>
321<TR>
322<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
323 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
324<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
325DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
326</TR>
327</TABLE>
328<A NAME="skip-navbar_bottom"></A>
329<!-- ======== END OF BOTTOM NAVBAR ======= -->
330
331<HR>
332Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
333</BODY>
334</HTML>
Note: See TracBrowser for help on using the repository browser.