| <!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.5.0_06) on Wed Jul 19 14:42:53 EDT 2006 --> |
| <TITLE> |
| ResourceLocator (Cayenne API Documentation - v.1.2) |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.objectstyle.cayenne.util.ResourceLocator class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../objectstyle-javadoc.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="ResourceLocator (Cayenne API Documentation - v.1.2)"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= 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="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/objectstyle/cayenne/util/RelationshipFault.html" title="class in org.objectstyle.cayenne.util"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.PredicateLogger.html" title="class in org.objectstyle.cayenne.util"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/util/ResourceLocator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ResourceLocator.html" target="_top"><B>NO FRAMES</B></A> |
| <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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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"> |
| org.objectstyle.cayenne.util</FONT> |
| <BR> |
| Class ResourceLocator</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.objectstyle.cayenne.util.ResourceLocator</B> |
| </PRE> |
| <DL> |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/objectstyle/cayenne/util/WebApplicationResourceLocator.html" title="class in org.objectstyle.cayenne.util">WebApplicationResourceLocator</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>ResourceLocator</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| Utility class to find resources (files, etc.), using a preconfigured strategy. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Author:</B></DT> |
| <DD>Andrei Adamchik</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| |
| <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.PredicateLogger.html" title="class in org.objectstyle.cayenne.util">ResourceLocator.PredicateLogger</A></B></CODE> |
| |
| <BR> |
| Custom logger that can be dynamically turned on/off by evaluating a Predicate.</TD> |
| </TR> |
| </TABLE> |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_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>Field Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#additionalClassPaths">additionalClassPaths</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#additionalFilesystemPaths">additionalFilesystemPaths</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.ClassLoader</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#classLoader">classLoader</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#skipAbsolutePath">skipAbsolutePath</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#skipClasspath">skipClasspath</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#skipCurrentDirectory">skipCurrentDirectory</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#skipHomeDirectory">skipHomeDirectory</A></B></CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== 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="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#ResourceLocator()">ResourceLocator</A></B>()</CODE> |
| |
| <BR> |
| Creates new ResourceLocator with default lookup policy including user home |
| directory, current directory and CLASSPATH.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== 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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#addClassPath(java.lang.String)">addClassPath</A></B>(java.lang.String customPath)</CODE> |
| |
| <BR> |
| Adds a custom path for class path lookups.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#addFilesystemPath(java.io.File)">addFilesystemPath</A></B>(java.io.File path)</CODE> |
| |
| <BR> |
| Adds the given directory as a path for filesystem lookups.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#addFilesystemPath(java.lang.String)">addFilesystemPath</A></B>(java.lang.String path)</CODE> |
| |
| <BR> |
| Adds the given String as a custom path for filesystem lookups.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#classBaseUrl(java.lang.Class)">classBaseUrl</A></B>(java.lang.Class aClass)</CODE> |
| |
| <BR> |
| Returns a base URL as a String from which this class was loaded.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.net.URL</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findDirectoryResource(java.lang.String)">findDirectoryResource</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Returns a directory resource URL using the lookup strategy configured for this |
| ResourceLocator or <code>null</code> if no readable resource can be found for the |
| given name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findFileInCurrentDirectory(java.lang.String)">findFileInCurrentDirectory</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Looks up a file in the current directory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findFileInFileSystem(java.lang.String)">findFileInFileSystem</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Looks up a file in the filesystem.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.io.File</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findFileInHomeDirectory(java.lang.String)">findFileInHomeDirectory</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Looks up a file in the user home directory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.net.URL</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findResource(java.lang.String)">findResource</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Returns a resource URL using the lookup strategy configured for this |
| Resourcelocator or <code>null</code> if no readable resource can be found for the |
| given name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.io.InputStream</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findResourceInClasspath(java.lang.String)">findResourceInClasspath</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Returns a resource as InputStream if it is found in CLASSPATH or <code>null</code> |
| otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.io.InputStream</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findResourceInFileSystem(java.lang.String)">findResourceInFileSystem</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Returns a resource as InputStream if it is found in the filesystem or |
| <code>null</code> otherwise.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.io.InputStream</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findResourceStream(java.lang.String)">findResourceStream</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Returns an InputStream on the found resource using the lookup strategy configured |
| for this ResourceLocator or <code>null</code> if no readable resource can be |
| found for the given name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.net.URL</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findURLInClassLoader(java.lang.String, java.lang.ClassLoader)">findURLInClassLoader</A></B>(java.lang.String name, |
| java.lang.ClassLoader loader)</CODE> |
| |
| <BR> |
| Looks up the URL for the named resource using the specified ClassLoader.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.net.URL</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findURLInClasspath(java.lang.String)">findURLInClasspath</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| Looks up the URL for the named resource using this class' ClassLoader.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.ClassLoader</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#getClassLoader()">getClassLoader</A></B>()</CODE> |
| |
| <BR> |
| Returns the ClassLoader associated with this ResourceLocator.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#setClassLoader(java.lang.ClassLoader)">setClassLoader</A></B>(java.lang.ClassLoader classLoader)</CODE> |
| |
| <BR> |
| Sets ClassLoader used to locate resources.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#setSkipAbsolutePath(boolean)">setSkipAbsolutePath</A></B>(boolean skipAbsPath)</CODE> |
| |
| <BR> |
| Sets "skipAbsolutePath" property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#setSkipClasspath(boolean)">setSkipClasspath</A></B>(boolean skipClasspath)</CODE> |
| |
| <BR> |
| Sets "skipClasspath" property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#setSkipCurrentDirectory(boolean)">setSkipCurrentDirectory</A></B>(boolean skipCurDir)</CODE> |
| |
| <BR> |
| Sets "skipCurrentDirectory" property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#setSkipHomeDirectory(boolean)">setSkipHomeDirectory</A></B>(boolean skipHomeDir)</CODE> |
| |
| <BR> |
| Sets "skipHomeDirectory" property.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#willSkipAbsolutePath()">willSkipAbsolutePath</A></B>()</CODE> |
| |
| <BR> |
| Returns true if no lookups are performed using path as absolute path.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#willSkipClasspath()">willSkipClasspath</A></B>()</CODE> |
| |
| <BR> |
| Returns true if no lookups are performed in the classpath.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#willSkipCurrentDirectory()">willSkipCurrentDirectory</A></B>()</CODE> |
| |
| <BR> |
| Returns true if no lookups are performed in the current directory.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#willSkipHomeDirectory()">willSkipHomeDirectory</A></B>()</CODE> |
| |
| <BR> |
| Returns true if no lookups are performed in the user home directory.</TD> |
| </TR> |
| </TABLE> |
| <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> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_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>Field Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="skipAbsolutePath"><!-- --></A><H3> |
| skipAbsolutePath</H3> |
| <PRE> |
| protected boolean <B>skipAbsolutePath</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="skipClasspath"><!-- --></A><H3> |
| skipClasspath</H3> |
| <PRE> |
| protected boolean <B>skipClasspath</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="skipCurrentDirectory"><!-- --></A><H3> |
| skipCurrentDirectory</H3> |
| <PRE> |
| protected boolean <B>skipCurrentDirectory</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="skipHomeDirectory"><!-- --></A><H3> |
| skipHomeDirectory</H3> |
| <PRE> |
| protected boolean <B>skipHomeDirectory</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="additionalClassPaths"><!-- --></A><H3> |
| additionalClassPaths</H3> |
| <PRE> |
| protected java.util.List <B>additionalClassPaths</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="additionalFilesystemPaths"><!-- --></A><H3> |
| additionalFilesystemPaths</H3> |
| <PRE> |
| protected java.util.List <B>additionalFilesystemPaths</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| <HR> |
| |
| <A NAME="classLoader"><!-- --></A><H3> |
| classLoader</H3> |
| <PRE> |
| protected java.lang.ClassLoader <B>classLoader</B></PRE> |
| <DL> |
| <DL> |
| </DL> |
| </DL> |
| |
| <!-- ========= 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>Creates new ResourceLocator with default lookup policy including user home |
| directory, current directory and CLASSPATH. |
| <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="findResourceInClasspath(java.lang.String)"><!-- --></A><H3> |
| findResourceInClasspath</H3> |
| <PRE> |
| public static java.io.InputStream <B>findResourceInClasspath</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Returns a resource as InputStream if it is found in CLASSPATH or <code>null</code> |
| otherwise. Lookup is normally performed in all JAR and ZIP files and directories |
| available to the ClassLoader. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findResourceInFileSystem(java.lang.String)"><!-- --></A><H3> |
| findResourceInFileSystem</H3> |
| <PRE> |
| public static java.io.InputStream <B>findResourceInFileSystem</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Returns a resource as InputStream if it is found in the filesystem or |
| <code>null</code> otherwise. Lookup is first performed relative to the user's |
| home directory (as defined by "user.home" system property), and then relative to |
| the current directory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findFileInFileSystem(java.lang.String)"><!-- --></A><H3> |
| findFileInFileSystem</H3> |
| <PRE> |
| public static java.io.File <B>findFileInFileSystem</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Looks up a file in the filesystem. First looks in the user home directory, then in |
| the current directory. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>file object matching the name, or null if file can not be found or if it is |
| not readable.<DT><B>See Also:</B><DD><A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findFileInHomeDirectory(java.lang.String)"><CODE>findFileInHomeDirectory(String)</CODE></A>, |
| <A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.html#findFileInCurrentDirectory(java.lang.String)"><CODE>findFileInCurrentDirectory(String)</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findFileInHomeDirectory(java.lang.String)"><!-- --></A><H3> |
| findFileInHomeDirectory</H3> |
| <PRE> |
| public static java.io.File <B>findFileInHomeDirectory</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Looks up a file in the user home directory. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>file object matching the name, or <code>null</code> if <code>file</code> |
| cannot be found or is not readable.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findFileInCurrentDirectory(java.lang.String)"><!-- --></A><H3> |
| findFileInCurrentDirectory</H3> |
| <PRE> |
| public static java.io.File <B>findFileInCurrentDirectory</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Looks up a file in the current directory. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>file object matching the name, or <code>null</code> if <code>file</code> |
| can not be found is not readable.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findURLInClasspath(java.lang.String)"><!-- --></A><H3> |
| findURLInClasspath</H3> |
| <PRE> |
| public static java.net.URL <B>findURLInClasspath</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Looks up the URL for the named resource using this class' ClassLoader. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findURLInClassLoader(java.lang.String, java.lang.ClassLoader)"><!-- --></A><H3> |
| findURLInClassLoader</H3> |
| <PRE> |
| public static java.net.URL <B>findURLInClassLoader</B>(java.lang.String name, |
| java.lang.ClassLoader loader)</PRE> |
| <DL> |
| <DD>Looks up the URL for the named resource using the specified ClassLoader. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="classBaseUrl(java.lang.Class)"><!-- --></A><H3> |
| classBaseUrl</H3> |
| <PRE> |
| public static java.lang.String <B>classBaseUrl</B>(java.lang.Class aClass)</PRE> |
| <DL> |
| <DD>Returns a base URL as a String from which this class was loaded. This is normally a |
| JAR or a file URL, but it is ClassLoader dependent. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findResourceStream(java.lang.String)"><!-- --></A><H3> |
| findResourceStream</H3> |
| <PRE> |
| public java.io.InputStream <B>findResourceStream</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Returns an InputStream on the found resource using the lookup strategy configured |
| for this ResourceLocator or <code>null</code> if no readable resource can be |
| found for the given name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findResource(java.lang.String)"><!-- --></A><H3> |
| findResource</H3> |
| <PRE> |
| public java.net.URL <B>findResource</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Returns a resource URL using the lookup strategy configured for this |
| Resourcelocator or <code>null</code> if no readable resource can be found for the |
| given name. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="findDirectoryResource(java.lang.String)"><!-- --></A><H3> |
| findDirectoryResource</H3> |
| <PRE> |
| public java.net.URL <B>findDirectoryResource</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD>Returns a directory resource URL using the lookup strategy configured for this |
| ResourceLocator or <code>null</code> if no readable resource can be found for the |
| given name. The returned resource is assumed to be a directory, so the returned URL |
| will be in a directory format (with "/" at the end). |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="willSkipHomeDirectory()"><!-- --></A><H3> |
| willSkipHomeDirectory</H3> |
| <PRE> |
| public boolean <B>willSkipHomeDirectory</B>()</PRE> |
| <DL> |
| <DD>Returns true if no lookups are performed in the user home directory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSkipHomeDirectory(boolean)"><!-- --></A><H3> |
| setSkipHomeDirectory</H3> |
| <PRE> |
| public void <B>setSkipHomeDirectory</B>(boolean skipHomeDir)</PRE> |
| <DL> |
| <DD>Sets "skipHomeDirectory" property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="willSkipCurrentDirectory()"><!-- --></A><H3> |
| willSkipCurrentDirectory</H3> |
| <PRE> |
| public boolean <B>willSkipCurrentDirectory</B>()</PRE> |
| <DL> |
| <DD>Returns true if no lookups are performed in the current directory. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSkipCurrentDirectory(boolean)"><!-- --></A><H3> |
| setSkipCurrentDirectory</H3> |
| <PRE> |
| public void <B>setSkipCurrentDirectory</B>(boolean skipCurDir)</PRE> |
| <DL> |
| <DD>Sets "skipCurrentDirectory" property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="willSkipClasspath()"><!-- --></A><H3> |
| willSkipClasspath</H3> |
| <PRE> |
| public boolean <B>willSkipClasspath</B>()</PRE> |
| <DL> |
| <DD>Returns true if no lookups are performed in the classpath. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSkipClasspath(boolean)"><!-- --></A><H3> |
| setSkipClasspath</H3> |
| <PRE> |
| public void <B>setSkipClasspath</B>(boolean skipClasspath)</PRE> |
| <DL> |
| <DD>Sets "skipClasspath" property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getClassLoader()"><!-- --></A><H3> |
| getClassLoader</H3> |
| <PRE> |
| public java.lang.ClassLoader <B>getClassLoader</B>()</PRE> |
| <DL> |
| <DD>Returns the ClassLoader associated with this ResourceLocator. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setClassLoader(java.lang.ClassLoader)"><!-- --></A><H3> |
| setClassLoader</H3> |
| <PRE> |
| public void <B>setClassLoader</B>(java.lang.ClassLoader classLoader)</PRE> |
| <DL> |
| <DD>Sets ClassLoader used to locate resources. If <code>null</code> is passed, the |
| ClassLoader of the ResourceLocator class will be used. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="willSkipAbsolutePath()"><!-- --></A><H3> |
| willSkipAbsolutePath</H3> |
| <PRE> |
| public boolean <B>willSkipAbsolutePath</B>()</PRE> |
| <DL> |
| <DD>Returns true if no lookups are performed using path as absolute path. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setSkipAbsolutePath(boolean)"><!-- --></A><H3> |
| setSkipAbsolutePath</H3> |
| <PRE> |
| public void <B>setSkipAbsolutePath</B>(boolean skipAbsPath)</PRE> |
| <DL> |
| <DD>Sets "skipAbsolutePath" property. |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addClassPath(java.lang.String)"><!-- --></A><H3> |
| addClassPath</H3> |
| <PRE> |
| public void <B>addClassPath</B>(java.lang.String customPath)</PRE> |
| <DL> |
| <DD>Adds a custom path for class path lookups. Format should be "my/package/name" |
| <i>without </i> leading "/". |
| <P> |
| <DD><DL> |
| </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addFilesystemPath(java.lang.String)"><!-- --></A><H3> |
| addFilesystemPath</H3> |
| <PRE> |
| public void <B>addFilesystemPath</B>(java.lang.String path)</PRE> |
| <DL> |
| <DD>Adds the given String as a custom path for filesystem lookups. The path can be |
| relative or absolute and is <i>not </i> checked for existence. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>path</code> is <code>null</code>.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addFilesystemPath(java.io.File)"><!-- --></A><H3> |
| addFilesystemPath</H3> |
| <PRE> |
| public void <B>addFilesystemPath</B>(java.io.File path)</PRE> |
| <DL> |
| <DD>Adds the given directory as a path for filesystem lookups. The directory is checked |
| for existence. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if <code>path</code> is <code>null</code>, |
| not a directory or not readable.</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="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/objectstyle/cayenne/util/RelationshipFault.html" title="class in org.objectstyle.cayenne.util"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/objectstyle/cayenne/util/ResourceLocator.PredicateLogger.html" title="class in org.objectstyle.cayenne.util"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/objectstyle/cayenne/util/ResourceLocator.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="ResourceLocator.html" target="_top"><B>NO FRAMES</B></A> |
| <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: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| <!--@SFLOGO@--> <i>Copyright © 2001-2006 <a href= |
| "http://objectstyle.org" target="_top">ObjectStyle.org</a> All Rights Reserved.</i> |
| |
| </BODY> |
| </HTML> |
