source: other-projects/trunk/gs3-release-maker/apache-ant-1.6.5/build/javadocs/org/apache/tools/ant/types/ResourceLocation.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.6 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:32 NZST 2007 -->
6<TITLE>
7ResourceLocation (Apache Ant API)
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.apache.tools.ant.types.ResourceLocation 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="ResourceLocation (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/Resource.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
53&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Substitution.html" title="class in org.apache.tools.ant.types"><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="ResourceLocation.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</FONT>
85<BR>
86Class ResourceLocation</H2>
87<PRE>
88java.lang.Object
89 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.tools.ant.types.ResourceLocation</B>
90</PRE>
91<DL>
92<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/tools/ant/types/DTDLocation.html" title="class in org.apache.tools.ant.types">DTDLocation</A></DD>
93</DL>
94<HR>
95<DL>
96<DT>public class <B>ResourceLocation</B><DT>extends java.lang.Object</DL>
97
98<P>
99<p>Helper class to handle the <code>&lt;dtd&gt;</code> and
100 <code>&lt;entity&gt;</code> nested elements. These correspond to
101 the <code>PUBLIC</code> and <code>URI</code> catalog entry types,
102 respectively, as defined in the <a
103 href="http://oasis-open.org/committees/entity/spec-2001-08-06.html">
104 OASIS "Open Catalog" standard</a>.</p>
105
106 <p>Possible Future Enhancements:
107 <ul>
108 <li>Bring the Ant element names into conformance with the OASIS standard</li>
109 <li>Add support for additional OASIS catalog entry types</li>
110 </ul>
111 </p>
112<P>
113
114<P>
115<DL>
116<DT><B>Since:</B></DT>
117 <DD>Ant 1.6</DD>
118<DT><B>See Also:</B><DD><CODE>org.apache.xml.resolver.Catalog</CODE></DL>
119<HR>
120
121<P>
122<!-- ======== NESTED CLASS SUMMARY ======== -->
123
124
125<!-- =========== FIELD SUMMARY =========== -->
126
127
128<!-- ======== CONSTRUCTOR SUMMARY ======== -->
129
130<A NAME="constructor_summary"><!-- --></A>
131<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
132<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
133<TD COLSPAN=2><FONT SIZE="+2">
134<B>Constructor Summary</B></FONT></TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html#ResourceLocation()">ResourceLocation</A></B>()</CODE>
138
139<BR>
140&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
141</TR>
142</TABLE>
143&nbsp;
144<!-- ========== METHOD SUMMARY =========== -->
145
146<A NAME="method_summary"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
149<TD COLSPAN=2><FONT SIZE="+2">
150<B>Method Summary</B></FONT></TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>&nbsp;java.net.URL</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html#getBase()">getBase</A></B>()</CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html#getLocation()">getLocation</A></B>()</CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html#getPublicId()">getPublicId</A></B>()</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;void</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html#setBase(java.net.URL)">setBase</A></B>(java.net.URL&nbsp;base)</CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;void</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html#setLocation(java.lang.String)">setLocation</A></B>(java.lang.String&nbsp;location)</CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>&nbsp;void</CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../../org/apache/tools/ant/types/ResourceLocation.html#setPublicId(java.lang.String)">setPublicId</A></B>(java.lang.String&nbsp;publicId)</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
199</TR>
200</TABLE>
201&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
203<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
204<TD><B>Methods inherited from class java.lang.Object</B></TD>
205</TR>
206<TR BGCOLOR="white" CLASS="TableRowColor">
207<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
208</TR>
209</TABLE>
210&nbsp;
211<P>
212
213<!-- ============ FIELD DETAIL =========== -->
214
215
216<!-- ========= CONSTRUCTOR DETAIL ======== -->
217
218<A NAME="constructor_detail"><!-- --></A>
219<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
220<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
221<TD COLSPAN=1><FONT SIZE="+2">
222<B>Constructor Detail</B></FONT></TD>
223</TR>
224</TABLE>
225
226<A NAME="ResourceLocation()"><!-- --></A><H3>
227ResourceLocation</H3>
228<PRE>
229public <B>ResourceLocation</B>()</PRE>
230<DL>
231</DL>
232
233<!-- ============ METHOD DETAIL ========== -->
234
235<A NAME="method_detail"><!-- --></A>
236<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
237<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
238<TD COLSPAN=1><FONT SIZE="+2">
239<B>Method Detail</B></FONT></TD>
240</TR>
241</TABLE>
242
243<A NAME="setPublicId(java.lang.String)"><!-- --></A><H3>
244setPublicId</H3>
245<PRE>
246public void <B>setPublicId</B>(java.lang.String&nbsp;publicId)</PRE>
247<DL>
248<DD><DL>
249<DT><B>Parameters:</B><DD><CODE>publicId</CODE> - uniquely identifies the resource.</DL>
250</DD>
251</DL>
252<HR>
253
254<A NAME="setLocation(java.lang.String)"><!-- --></A><H3>
255setLocation</H3>
256<PRE>
257public void <B>setLocation</B>(java.lang.String&nbsp;location)</PRE>
258<DL>
259<DD><DL>
260<DT><B>Parameters:</B><DD><CODE>location</CODE> - the location of the resource associated with the
261 publicId.</DL>
262</DD>
263</DL>
264<HR>
265
266<A NAME="setBase(java.net.URL)"><!-- --></A><H3>
267setBase</H3>
268<PRE>
269public void <B>setBase</B>(java.net.URL&nbsp;base)</PRE>
270<DL>
271<DD><DL>
272<DT><B>Parameters:</B><DD><CODE>base</CODE> - the base URL of the resource associated with the
273 publicId. If the location specifies a relative URL/pathname,
274 it is resolved using the base. The default base for an
275 external catalog file is the directory in which it is located.</DL>
276</DD>
277</DL>
278<HR>
279
280<A NAME="getPublicId()"><!-- --></A><H3>
281getPublicId</H3>
282<PRE>
283public java.lang.String <B>getPublicId</B>()</PRE>
284<DL>
285<DD><DL>
286
287<DT><B>Returns:</B><DD>the publicId of the resource.</DL>
288</DD>
289</DL>
290<HR>
291
292<A NAME="getLocation()"><!-- --></A><H3>
293getLocation</H3>
294<PRE>
295public java.lang.String <B>getLocation</B>()</PRE>
296<DL>
297<DD><DL>
298
299<DT><B>Returns:</B><DD>the location of the resource identified by the publicId.</DL>
300</DD>
301</DL>
302<HR>
303
304<A NAME="getBase()"><!-- --></A><H3>
305getBase</H3>
306<PRE>
307public java.net.URL <B>getBase</B>()</PRE>
308<DL>
309<DD><DL>
310
311<DT><B>Returns:</B><DD>the base of the resource identified by the publicId.</DL>
312</DD>
313</DL>
314<!-- ========= END OF CLASS DATA ========= -->
315<HR>
316
317
318<!-- ======= START OF BOTTOM NAVBAR ====== -->
319<A NAME="navbar_bottom"><!-- --></A>
320<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
321<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
322<TR>
323<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
324<A NAME="navbar_bottom_firstrow"><!-- --></A>
325<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
326 <TR ALIGN="center" VALIGN="top">
327 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
328 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
329 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
330 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
331 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
332 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
333 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
334 </TR>
335</TABLE>
336</TD>
337<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
338</EM>
339</TD>
340</TR>
341
342<TR>
343<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
344&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Resource.html" title="class in org.apache.tools.ant.types"><B>PREV CLASS</B></A>&nbsp;
345&nbsp;<A HREF="../../../../../org/apache/tools/ant/types/Substitution.html" title="class in org.apache.tools.ant.types"><B>NEXT CLASS</B></A></FONT></TD>
346<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
347 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
348&nbsp;<A HREF="ResourceLocation.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
349&nbsp;<SCRIPT type="text/javascript">
350 <!--
351 if(window==top) {
352 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
353 }
354 //-->
355</SCRIPT>
356<NOSCRIPT>
357 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
358</NOSCRIPT>
359
360</FONT></TD>
361</TR>
362<TR>
363<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
364 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
365<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
366DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
367</TR>
368</TABLE>
369<A NAME="skip-navbar_bottom"></A>
370<!-- ======== END OF BOTTOM NAVBAR ======= -->
371
372<HR>
373Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.
374</BODY>
375</HTML>
Note: See TracBrowser for help on using the repository browser.