2012-04-19 15:10:06 +02:00

420 lines
18 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_20) on Fri Jul 16 20:05:54 CEST 2010 -->
<TITLE>
ResourceLocator
</TITLE>
<META NAME="date" CONTENT="2010-07-16">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ResourceLocator";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../translator/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ResourceLocator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../translator/ResourceChecker.html" title="class in translator"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../translator/StaticExtendedResourceBundle.html" title="class in translator"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html?translator/ResourceLocator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ResourceLocator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
translator</FONT>
<BR>
Class ResourceLocator</H2>
<PRE>
java.lang.Object
<IMG SRC="../resources/inherit.gif" ALT="extended by "><B>translator.ResourceLocator</B>
</PRE>
<HR>
<DL>
<DT><PRE>public class <B>ResourceLocator</B><DT>extends java.lang.Object</DL>
</PRE>
<P>
This class encapsulates the loading of (almost) arbitrary resources. Resource
loading is performed by checking the following approaches:
<ol>
<li>Loading using <code>Class.getResourceAsStream()</code></li>
<li>Loading using <code>ClassLoader.getSystemResourceAsStream()</code></li>
<li>Loading using the <em>codebase</em> as a URL, if it Applet mode</li>
<li>Loading using a <code>FileInputStream</code> (not possible for Applets
and WebStart applications)</li>
</ol>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>0.7 10.06.2005</DD>
<DT><B>Author:</B></DT>
<DD>Guido Roessling (roessling@acm.org></DD>
</DL>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../translator/ResourceLocator.html#ResourceLocator()">ResourceLocator</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(empty) default constructor</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="../translator/ResourceLocator.html" title="class in translator">ResourceLocator</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../translator/ResourceLocator.html#getResourceLocator()">getResourceLocator</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;returns the current (internal) locator, creating a new one first if needed</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.io.InputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../translator/ResourceLocator.html#getResourceStream(java.lang.String)">getResourceStream</A></B>(java.lang.String&nbsp;resourceName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve a resource by its name in String format</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.io.InputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../translator/ResourceLocator.html#getResourceStream(java.lang.String, boolean, java.net.URL)">getResourceStream</A></B>(java.lang.String&nbsp;resourceName,
boolean&nbsp;runsAsApplet,
java.net.URL&nbsp;codeBaseName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve a resource by its name in String format, a boolean indicating if
the current environment is an Applet, and the codebase, if so.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.io.InputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../translator/ResourceLocator.html#getResourceStream(java.lang.String, java.lang.String)">getResourceStream</A></B>(java.lang.String&nbsp;resourceName,
java.lang.String&nbsp;extension)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve a resource by its name and extension in String format</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.io.InputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../translator/ResourceLocator.html#getResourceStream(java.lang.String, java.lang.String, boolean, java.net.URL)">getResourceStream</A></B>(java.lang.String&nbsp;resourceName,
java.lang.String&nbsp;extension,
boolean&nbsp;runsAsApplet,
java.net.URL&nbsp;codeBase)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve a resource by its name and extension in String format, a boolean
indicating if the current environment is an Applet, and the codebase, if
so.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.io.InputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../translator/ResourceLocator.html#getResourceStream(java.lang.String, java.lang.String, java.lang.String)">getResourceStream</A></B>(java.lang.String&nbsp;resourceName,
java.lang.String&nbsp;extension,
java.lang.String&nbsp;directoryName)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieve a resource by its name and extension plus directory in String
format.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ResourceLocator()"><!-- --></A><H3>
ResourceLocator</H3>
<PRE>
public <B>ResourceLocator</B>()</PRE>
<DL>
<DD>(empty) default constructor
<P>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getResourceLocator()"><!-- --></A><H3>
getResourceLocator</H3>
<PRE>
public static <A HREF="../translator/ResourceLocator.html" title="class in translator">ResourceLocator</A> <B>getResourceLocator</B>()</PRE>
<DL>
<DD>returns the current (internal) locator, creating a new one first if needed
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the current ResourceLocator; if none is present, generates one
first.</DL>
</DD>
</DL>
<HR>
<A NAME="getResourceStream(java.lang.String)"><!-- --></A><H3>
getResourceStream</H3>
<PRE>
public java.io.InputStream <B>getResourceStream</B>(java.lang.String&nbsp;resourceName)</PRE>
<DL>
<DD>Retrieve a resource by its name in String format
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceName</CODE> - the name of the resource to be loaded
<DT><B>Returns:</B><DD>an <code>InputStream</code> to the resource. May be null if none
of the approaches taken can locate the resource.<DT><B>See Also:</B><DD><A HREF="../translator/ResourceLocator.html#getResourceStream(java.lang.String, java.lang.String, boolean, java.net.URL)"><CODE>getResourceStream(String, String, boolean, URL)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getResourceStream(java.lang.String, java.lang.String)"><!-- --></A><H3>
getResourceStream</H3>
<PRE>
public java.io.InputStream <B>getResourceStream</B>(java.lang.String&nbsp;resourceName,
java.lang.String&nbsp;extension)</PRE>
<DL>
<DD>Retrieve a resource by its name and extension in String format
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceName</CODE> - the name of the resource to be loaded<DD><CODE>extension</CODE> - the filename extension, important e.g. for I18N applications where
the filename encodes the locale.
<DT><B>Returns:</B><DD>an <code>InputStream</code> to the resource. May be null if none
of the approaches taken can locate the resource.<DT><B>See Also:</B><DD><A HREF="../translator/ResourceLocator.html#getResourceStream(java.lang.String, java.lang.String, boolean, java.net.URL)"><CODE>getResourceStream(String, String, boolean, URL)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getResourceStream(java.lang.String, boolean, java.net.URL)"><!-- --></A><H3>
getResourceStream</H3>
<PRE>
public java.io.InputStream <B>getResourceStream</B>(java.lang.String&nbsp;resourceName,
boolean&nbsp;runsAsApplet,
java.net.URL&nbsp;codeBaseName)</PRE>
<DL>
<DD>Retrieve a resource by its name in String format, a boolean indicating if
the current environment is an Applet, and the codebase, if so.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceName</CODE> - the name of the resource to be loaded<DD><CODE>runsAsApplet</CODE> - indicates if this is an Application (=<code>false</code>) or
an Applet (=<code>true</code>)<DD><CODE>codeBaseName</CODE> - the URL pointing towards the Applet's codebase, if this is
actually an Applet (<code>runsAsApplet == true</code>)
<DT><B>Returns:</B><DD>an <code>InputStream</code> to the resource. May be null if none
of the approaches taken can locate the resource.<DT><B>See Also:</B><DD><A HREF="../translator/ResourceLocator.html#getResourceStream(java.lang.String, java.lang.String, boolean, java.net.URL)"><CODE>getResourceStream(String, String, boolean, URL)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getResourceStream(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
getResourceStream</H3>
<PRE>
public java.io.InputStream <B>getResourceStream</B>(java.lang.String&nbsp;resourceName,
java.lang.String&nbsp;extension,
java.lang.String&nbsp;directoryName)</PRE>
<DL>
<DD>Retrieve a resource by its name and extension plus directory in String
format.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceName</CODE> - the name of the resource to be loaded<DD><CODE>extension</CODE> - the filename's extension (if any - else <code>null</code>)<DD><CODE>directoryName</CODE> - the path for the file
<DT><B>Returns:</B><DD>an <code>InputStream</code> to the resource. May be null if none
of the approaches taken can locate the resource.<DT><B>See Also:</B><DD><A HREF="../translator/ResourceLocator.html#getResourceStream(java.lang.String, java.lang.String, boolean, java.net.URL)"><CODE>getResourceStream(String, String, boolean, URL)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getResourceStream(java.lang.String, java.lang.String, boolean, java.net.URL)"><!-- --></A><H3>
getResourceStream</H3>
<PRE>
public java.io.InputStream <B>getResourceStream</B>(java.lang.String&nbsp;resourceName,
java.lang.String&nbsp;extension,
boolean&nbsp;runsAsApplet,
java.net.URL&nbsp;codeBase)</PRE>
<DL>
<DD>Retrieve a resource by its name and extension in String format, a boolean
indicating if the current environment is an Applet, and the codebase, if
so.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>resourceName</CODE> - the name of the resource to be loaded<DD><CODE>extension</CODE> - the filename's extension (if any - else <code>null</code>)<DD><CODE>runsAsApplet</CODE> - indicates if this is an Application (=<code>false</code>) or
an Applet (=<code>true</code>)<DD><CODE>codeBase</CODE> - the URL pointing towards the Applet's codebase, if this is
actually an Applet (<code>runsAsApplet == true</code>)
<DT><B>Returns:</B><DD>an <code>InputStream</code> to the resource. May be null if none
of the approaches taken can locate the resource.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../translator/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ResourceLocator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../translator/ResourceChecker.html" title="class in translator"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../translator/StaticExtendedResourceBundle.html" title="class in translator"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../index.html?translator/ResourceLocator.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="ResourceLocator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>