| <!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_14) on Mon Apr 26 10:16:12 PDT 2010 --> | |
| <TITLE> | |
| ConfigurationUtils (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.config.ConfigurationUtils class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="ConfigurationUtils (VelocityTools 2.0 Documentation)"; | |
| } | |
| </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-all.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/apache/velocity/tools/config/ConfigurationException.html" title="class in org.apache.velocity.tools.config"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/config/Data.html" title="class in org.apache.velocity.tools.config"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/config/ConfigurationUtils.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ConfigurationUtils.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: NESTED | <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.apache.velocity.tools.config</FONT> | |
| <BR> | |
| Class ConfigurationUtils</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.config.ConfigurationUtils</B> | |
| </PRE> | |
| <HR> | |
| <DL> | |
| <DT><PRE>public class <B>ConfigurationUtils</B><DT>extends java.lang.Object</DL> | |
| </PRE> | |
| <P> | |
| Utility methods for handling tool configurations. | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Id: ConfigurationUtils.java 511959 2007-02-26 19:24:39Z nbubna $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD>Nathan Bubna</DD> | |
| </DL> | |
| <HR> | |
| <P> | |
| <!-- =========== 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>static java.lang.String</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#AUTOLOADED_PROPS_PATH">AUTOLOADED_PROPS_PATH</A></B></CODE> | |
| <BR> | |
| </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/apache/velocity/tools/config/ConfigurationUtils.html#AUTOLOADED_XML_PATH">AUTOLOADED_XML_PATH</A></B></CODE> | |
| <BR> | |
| </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/apache/velocity/tools/config/ConfigurationUtils.html#CONFIG_FACTORY_METHOD">CONFIG_FACTORY_METHOD</A></B></CODE> | |
| <BR> | |
| </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/apache/velocity/tools/config/ConfigurationUtils.html#GENERIC_DEFAULTS_PATH">GENERIC_DEFAULTS_PATH</A></B></CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html" title="class in org.apache.velocity.tools.config">ConfigurationUtils</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#INSTANCE">INSTANCE</A></B></CODE> | |
| <BR> | |
| </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/apache/velocity/tools/config/ConfigurationUtils.html#STRUTS_DEFAULTS_PATH">STRUTS_DEFAULTS_PATH</A></B></CODE> | |
| <BR> | |
| </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/apache/velocity/tools/config/ConfigurationUtils.html#SYSTEM_PROPERTY_KEY">SYSTEM_PROPERTY_KEY</A></B></CODE> | |
| <BR> | |
| </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/apache/velocity/tools/config/ConfigurationUtils.html#VIEW_DEFAULTS_PATH">VIEW_DEFAULTS_PATH</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 ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private </CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#ConfigurationUtils()">ConfigurationUtils</A></B>()</CODE> | |
| <BR> | |
| </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>static void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#clean(org.apache.velocity.tools.config.Configuration)">clean</A></B>(<A HREF="../../../../../org/apache/velocity/tools/config/Configuration.html" title="class in org.apache.velocity.tools.config">Configuration</A> config)</CODE> | |
| <BR> | |
| Convenience method that automatically creates a new | |
| <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationCleaner.html" title="class in org.apache.velocity.tools.config"><CODE>ConfigurationCleaner</CODE></A> and applies it to the specified | |
| <A HREF="../../../../../org/apache/velocity/tools/config/Configuration.html" title="class in org.apache.velocity.tools.config"><CODE>Configuration</CODE></A>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#createFactory()">createFactory</A></B>()</CODE> | |
| <BR> | |
| Returns a new, standard <A HREF="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><CODE>ToolboxFactory</CODE></A> configured | |
| with the results of both <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getAutoLoaded()"><CODE>getAutoLoaded()</CODE></A> and | |
| <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#findFromSystemProperty()"><CODE>findFromSystemProperty()</CODE></A>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#find(java.lang.String)">find</A></B>(java.lang.String path)</CODE> | |
| <BR> | |
| Searches for a configuration file at the specified path and returns | |
| it in the form of a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#findFromSystemProperty()">findFromSystemProperty</A></B>()</CODE> | |
| <BR> | |
| Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> loaded from the path specified | |
| in the "org.apache.velocity.tools" system property (if any).</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#findInClasspath(java.lang.String)">findInClasspath</A></B>(java.lang.String path)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#findInClasspath(java.lang.String, java.lang.Object)">findInClasspath</A></B>(java.lang.String path, | |
| java.lang.Object caller)</CODE> | |
| <BR> | |
| Searches the classpath for a configuration file matching the | |
| specified path.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#findInFileSystem(java.lang.String)">findInFileSystem</A></B>(java.lang.String path)</CODE> | |
| <BR> | |
| Searches the file system for a configuration file matching the | |
| specified path.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getAutoLoaded()">getAutoLoaded</A></B>()</CODE> | |
| <BR> | |
| Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> including all | |
| <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getDefaultTools()"><CODE>getDefaultTools()</CODE></A> as well as any tools that can be | |
| automatically loaded from "tools.xml" or "tools.properties" found | |
| at the root of the classpath or in the current directory.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getAutoLoaded(boolean)">getAutoLoaded</A></B>(boolean includeDefaults)</CODE> | |
| <BR> | |
| Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> composed, in order of the | |
| following configurations: | |
| <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getDefaultTools()"><CODE>getDefaultTools()</CODE></A> (only if includeDefaults is <code>true</code>) | |
| All "tools.xml" configurations found in the classpath root, in the order found | |
| All "tools.properties" configurations found in the classpath root, in the order found | |
| The "tools.xml" file in the current directory (if any) | |
| The "tools.properties" file in the current directory (if any) | |
| If the includeDefaults parameter is null and no such files described above | |
| can be found, then the configuration returned by this method will be | |
| empty, but it should never be <code>null</code>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getDefaultTools()">getDefaultTools</A></B>()</CODE> | |
| <BR> | |
| Returns the "default" <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A>.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getFromClass(java.lang.Class)">getFromClass</A></B>(java.lang.Class factory)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getFromClass(java.lang.String)">getFromClass</A></B>(java.lang.String classname)</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getGenericTools()">getGenericTools</A></B>()</CODE> | |
| <BR> | |
| Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> including all default | |
| "GenericTools" available and no others.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html" title="class in org.apache.velocity.tools.config">ConfigurationUtils</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getInstance()">getInstance</A></B>()</CODE> | |
| <BR> | |
| </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getVelocityStruts()">getVelocityStruts</A></B>()</CODE> | |
| <BR> | |
| Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> including all default | |
| "VelocityStruts" tools available as well as the default "VelocityView" | |
| tools and "GenericTools".</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getVelocityView()">getVelocityView</A></B>()</CODE> | |
| <BR> | |
| Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> including all default | |
| "VelocityView" tools available as well as the default "GenericTools".</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#load(java.lang.String)">load</A></B>(java.lang.String path)</CODE> | |
| <BR> | |
| Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> loaded from a configuration file | |
| at the specified path.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A></CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#read(java.net.URL)">read</A></B>(java.net.URL url)</CODE> | |
| <BR> | |
| Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> read from a known configuration | |
| file type at the specified <CODE>URL</CODE>.</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="GENERIC_DEFAULTS_PATH"><!-- --></A><H3> | |
| GENERIC_DEFAULTS_PATH</H3> | |
| <PRE> | |
| public static final java.lang.String <B>GENERIC_DEFAULTS_PATH</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.config.ConfigurationUtils.GENERIC_DEFAULTS_PATH">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="VIEW_DEFAULTS_PATH"><!-- --></A><H3> | |
| VIEW_DEFAULTS_PATH</H3> | |
| <PRE> | |
| public static final java.lang.String <B>VIEW_DEFAULTS_PATH</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.config.ConfigurationUtils.VIEW_DEFAULTS_PATH">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="STRUTS_DEFAULTS_PATH"><!-- --></A><H3> | |
| STRUTS_DEFAULTS_PATH</H3> | |
| <PRE> | |
| public static final java.lang.String <B>STRUTS_DEFAULTS_PATH</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.config.ConfigurationUtils.STRUTS_DEFAULTS_PATH">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="AUTOLOADED_XML_PATH"><!-- --></A><H3> | |
| AUTOLOADED_XML_PATH</H3> | |
| <PRE> | |
| public static final java.lang.String <B>AUTOLOADED_XML_PATH</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.config.ConfigurationUtils.AUTOLOADED_XML_PATH">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="AUTOLOADED_PROPS_PATH"><!-- --></A><H3> | |
| AUTOLOADED_PROPS_PATH</H3> | |
| <PRE> | |
| public static final java.lang.String <B>AUTOLOADED_PROPS_PATH</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.config.ConfigurationUtils.AUTOLOADED_PROPS_PATH">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="SYSTEM_PROPERTY_KEY"><!-- --></A><H3> | |
| SYSTEM_PROPERTY_KEY</H3> | |
| <PRE> | |
| public static final java.lang.String <B>SYSTEM_PROPERTY_KEY</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.config.ConfigurationUtils.SYSTEM_PROPERTY_KEY">Constant Field Values</A></DL> | |
| </DL> | |
| <HR> | |
| <A NAME="INSTANCE"><!-- --></A><H3> | |
| INSTANCE</H3> | |
| <PRE> | |
| public static final <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html" title="class in org.apache.velocity.tools.config">ConfigurationUtils</A> <B>INSTANCE</B></PRE> | |
| <DL> | |
| <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="CONFIG_FACTORY_METHOD"><!-- --></A><H3> | |
| CONFIG_FACTORY_METHOD</H3> | |
| <PRE> | |
| public static final java.lang.String <B>CONFIG_FACTORY_METHOD</B></PRE> | |
| <DL> | |
| <DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.velocity.tools.config.ConfigurationUtils.CONFIG_FACTORY_METHOD">Constant Field Values</A></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="ConfigurationUtils()"><!-- --></A><H3> | |
| ConfigurationUtils</H3> | |
| <PRE> | |
| private <B>ConfigurationUtils</B>()</PRE> | |
| <DL> | |
| </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="getInstance()"><!-- --></A><H3> | |
| getInstance</H3> | |
| <PRE> | |
| public <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html" title="class in org.apache.velocity.tools.config">ConfigurationUtils</A> <B>getInstance</B>()</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getDefaultTools()"><!-- --></A><H3> | |
| getDefaultTools</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>getDefaultTools</B>()</PRE> | |
| <DL> | |
| <DD>Returns the "default" <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A>. This includes | |
| all the standard tools developed by this project and available in | |
| the jar being used. In other words, if the velocity-tools-generic-2.x.jar | |
| is being used, then only the generic tools will be included. If | |
| the velocity-tools-struts-2.x.jar is being used, then all VelocityTools | |
| will be available. This also means that subclasses in the larger jars | |
| will override their superclasses. So, if you are using the VelocityStruts | |
| jar, then your $link reference will be a StrutsLinkTool. If you are using | |
| the VelocityView jar, it will be a standard LinkTool. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getGenericTools()"><!-- --></A><H3> | |
| getGenericTools</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>getGenericTools</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> including all default | |
| "GenericTools" available and no others. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getVelocityView()"><!-- --></A><H3> | |
| getVelocityView</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>getVelocityView</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> including all default | |
| "VelocityView" tools available as well as the default "GenericTools". | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>{@link</CODE> - ConfigurationException} if a tools.xml is not found | |
| at the <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#VIEW_DEFAULTS_PATH"><CODE>VIEW_DEFAULTS_PATH</CODE></A>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getVelocityStruts()"><!-- --></A><H3> | |
| getVelocityStruts</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>getVelocityStruts</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> including all default | |
| "VelocityStruts" tools available as well as the default "VelocityView" | |
| tools and "GenericTools". | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>{@link</CODE> - ConfigurationException} if a tools.xml is not found | |
| at the <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#VIEW_DEFAULTS_PATH"><CODE>VIEW_DEFAULTS_PATH</CODE></A> or <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#STRUTS_DEFAULTS_PATH"><CODE>STRUTS_DEFAULTS_PATH</CODE></A>.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getAutoLoaded()"><!-- --></A><H3> | |
| getAutoLoaded</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>getAutoLoaded</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> including all | |
| <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getDefaultTools()"><CODE>getDefaultTools()</CODE></A> as well as any tools that can be | |
| automatically loaded from "tools.xml" or "tools.properties" found | |
| at the root of the classpath or in the current directory. | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getAutoLoaded(boolean)"><CODE>getAutoLoaded(boolean includeDefaults)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getAutoLoaded(boolean)"><!-- --></A><H3> | |
| getAutoLoaded</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>getAutoLoaded</B>(boolean includeDefaults)</PRE> | |
| <DL> | |
| <DD>Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> composed, in order of the | |
| following configurations: | |
| <ul> | |
| <li><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getDefaultTools()"><CODE>getDefaultTools()</CODE></A> (only if includeDefaults is <code>true</code>)</li> | |
| <li>All "tools.xml" configurations found in the classpath root, in the order found</li> | |
| <li>All "tools.properties" configurations found in the classpath root, in the order found</li> | |
| <li>The "tools.xml" file in the current directory (if any)</li> | |
| <li>The "tools.properties" file in the current directory (if any)</li> | |
| </ul> | |
| If the includeDefaults parameter is null and no such files described above | |
| can be found, then the configuration returned by this method will be | |
| empty, but it should never be <code>null</code>. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="findFromSystemProperty()"><!-- --></A><H3> | |
| findFromSystemProperty</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>findFromSystemProperty</B>()</PRE> | |
| <DL> | |
| <DD>Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> loaded from the path specified | |
| in the "org.apache.velocity.tools" system property (if any). | |
| If no such property has been set <code>null</code> will be returned. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>org.apache.velocity.exception.ResourceNotFoundException</CODE> - if the system property has a value | |
| but no configuration file was found at the specified location</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="createFactory()"><!-- --></A><H3> | |
| createFactory</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools">ToolboxFactory</A> <B>createFactory</B>()</PRE> | |
| <DL> | |
| <DD>Returns a new, standard <A HREF="../../../../../org/apache/velocity/tools/ToolboxFactory.html" title="class in org.apache.velocity.tools"><CODE>ToolboxFactory</CODE></A> configured | |
| with the results of both <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#getAutoLoaded()"><CODE>getAutoLoaded()</CODE></A> and | |
| <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#findFromSystemProperty()"><CODE>findFromSystemProperty()</CODE></A>. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="clean(org.apache.velocity.tools.config.Configuration)"><!-- --></A><H3> | |
| clean</H3> | |
| <PRE> | |
| public static void <B>clean</B>(<A HREF="../../../../../org/apache/velocity/tools/config/Configuration.html" title="class in org.apache.velocity.tools.config">Configuration</A> config)</PRE> | |
| <DL> | |
| <DD>Convenience method that automatically creates a new | |
| <A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationCleaner.html" title="class in org.apache.velocity.tools.config"><CODE>ConfigurationCleaner</CODE></A> and applies it to the specified | |
| <A HREF="../../../../../org/apache/velocity/tools/config/Configuration.html" title="class in org.apache.velocity.tools.config"><CODE>Configuration</CODE></A>. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="load(java.lang.String)"><!-- --></A><H3> | |
| load</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>load</B>(java.lang.String path)</PRE> | |
| <DL> | |
| <DD>Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> loaded from a configuration file | |
| at the specified path. If no such file is found at that path, this | |
| will throw a <CODE>ResourceNotFoundException</CODE>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#find(java.lang.String)"><CODE>find(String path)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="find(java.lang.String)"><!-- --></A><H3> | |
| find</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>find</B>(java.lang.String path)</PRE> | |
| <DL> | |
| <DD>Searches for a configuration file at the specified path and returns | |
| it in the form of a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A>. This method will | |
| look for a matching file in both the classpath and the file system. | |
| If perchance a match is found in both, then both are loaded and the | |
| configuration loaded from the file system is given precedence (i.e. | |
| it is added onto the other). If no match is found in either, then | |
| this will return <code>null</code>. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="findInFileSystem(java.lang.String)"><!-- --></A><H3> | |
| findInFileSystem</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>findInFileSystem</B>(java.lang.String path)</PRE> | |
| <DL> | |
| <DD>Searches the file system for a configuration file matching the | |
| specified path. If found, it will read and return it as a | |
| <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A>. If not found, this will return | |
| <code>null</code>. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.lang.IllegalStateException</CODE> - if the file exists, but its path could not be converted to a URL for reading.</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="findInClasspath(java.lang.String)"><!-- --></A><H3> | |
| findInClasspath</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>findInClasspath</B>(java.lang.String path)</PRE> | |
| <DL> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/config/ConfigurationUtils.html#findInClasspath(java.lang.String, java.lang.Object)"><CODE>findInClasspath(String path, Object caller)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="findInClasspath(java.lang.String, java.lang.Object)"><!-- --></A><H3> | |
| findInClasspath</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>findInClasspath</B>(java.lang.String path, | |
| java.lang.Object caller)</PRE> | |
| <DL> | |
| <DD>Searches the classpath for a configuration file matching the | |
| specified path. If found, it will read and return it as a | |
| <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A>. If not found, this will return | |
| <code>null</code>. If there are multiple matching resources in the | |
| classpath, then they will be added together in the order found | |
| (i.e. the last one will have precedence). | |
| <P> | |
| <DD><DL> | |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/velocity/tools/ClassUtils.html#getResources(java.lang.String, java.lang.Object)"><CODE>ClassUtils.getResources(String path, Object caller)</CODE></A></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="read(java.net.URL)"><!-- --></A><H3> | |
| read</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>read</B>(java.net.URL url)</PRE> | |
| <DL> | |
| <DD>Returns a <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>FactoryConfiguration</CODE></A> read from a known configuration | |
| file type at the specified <CODE>URL</CODE>. If the file is missing or unreadable, | |
| this will simply return <code>null</code> (i.e. if an IOException is thrown). | |
| <P> | |
| <DD><DL> | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.lang.UnsupportedOperationException</CODE> - if the file type (identified via suffix) | |
| is neither ".xml" or ".properties"</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getFromClass(java.lang.String)"><!-- --></A><H3> | |
| getFromClass</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>getFromClass</B>(java.lang.String classname)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getFromClass(java.lang.Class)"><!-- --></A><H3> | |
| getFromClass</H3> | |
| <PRE> | |
| public static <A HREF="../../../../../org/apache/velocity/tools/config/FactoryConfiguration.html" title="class in org.apache.velocity.tools.config">FactoryConfiguration</A> <B>getFromClass</B>(java.lang.Class factory)</PRE> | |
| <DL> | |
| <DD><DL> | |
| </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-all.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/apache/velocity/tools/config/ConfigurationException.html" title="class in org.apache.velocity.tools.config"><B>PREV CLASS</B></A> | |
| <A HREF="../../../../../org/apache/velocity/tools/config/Data.html" title="class in org.apache.velocity.tools.config"><B>NEXT CLASS</B></A></FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/config/ConfigurationUtils.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="ConfigurationUtils.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: NESTED | <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> | |
| Copyright (c) 2003-2007 Apache Software Foundation | |
| </BODY> | |
| </HTML> |