| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc on Wed Apr 14 08:26:33 EDT 2004 --> |
| <TITLE> |
| Velocity 1.4 API: Class Configuration |
| </TITLE> |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| </HEAD> |
| <BODY BGCOLOR="white"> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_top"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <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="class-use/Configuration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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"> |
| PREV CLASS |
| <A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.PropertiesReader.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="Configuration.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#inner_class_summary">INNER</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> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.velocity.runtime.configuration</FONT> |
| <BR> |
| Class Configuration</H2> |
| <PRE> |
| java.lang.Object |
| | |
| +--java.util.Dictionary |
| | |
| +--java.util.Hashtable |
| | |
| +--<B>org.apache.velocity.runtime.configuration.Configuration</B> |
| </PRE> |
| <DL> |
| <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable, java.util.Map, java.io.Serializable</DD> |
| </DL> |
| <HR> |
| <B>Deprecated.</B> <I>As of version 1.1, please use ExtendedProperties from |
| the Jakarta Commons Collections component.</I> |
| <P> |
| <DL> |
| <DT>public class <B>Configuration</B><DT>extends java.util.Hashtable</DL> |
| |
| <P> |
| This class extends normal Java properties by adding the possibility |
| to use the same key many times concatenating the value strings |
| instead of overwriting them. |
| |
| <p>The Extended Properties syntax is explained here: |
| |
| <ul> |
| <li> |
| Each property has the syntax <code>key = value</code> |
| </li> |
| <li> |
| The <i>key</i> may use any character but the equal sign '='. |
| </li> |
| <li> |
| <i>value</i> may be separated on different lines if a backslash |
| is placed at the end of the line that continues below. |
| </li> |
| <li> |
| If <i>value</i> is a list of strings, each token is separated |
| by a comma ','. |
| </li> |
| <li> |
| Commas in each token are escaped placing a backslash right before |
| the comma. |
| </li> |
| <li> |
| If a <i>key</i> is used more than once, the values are appended |
| like if they were on the same line separated with commas. |
| </li> |
| <li> |
| Blank lines and lines starting with character '#' are skipped. |
| </li> |
| <li> |
| If a property is named "include" (or whatever is defined by |
| setInclude() and getInclude() and the value of that property is |
| the full path to a file on disk, that file will be included into |
| the ConfigurationsRepository. You can also pull in files relative |
| to the parent configuration file. So if you have something |
| like the following: |
| |
| include = additional.properties |
| |
| Then "additional.properties" is expected to be in the same |
| directory as the parent configuration file. |
| |
| Duplicate name values will be replaced, so be careful. |
| |
| </li> |
| </ul> |
| |
| <p>Here is an example of a valid extended properties file: |
| |
| <p><pre> |
| # lines starting with # are comments |
| |
| # This is the simplest property |
| key = value |
| |
| # A long property may be separated on multiple lines |
| longvalue = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \ |
| aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa |
| |
| # This is a property with many tokens |
| tokens_on_a_line = first token, second token |
| |
| # This sequence generates exactly the same result |
| tokens_on_multiple_lines = first token |
| tokens_on_multiple_lines = second token |
| |
| # commas may be escaped in tokens |
| commas.excaped = Hi\, what'up? |
| </pre> |
| |
| <p><b>NOTE</b>: this class has <b>not</b> been written for |
| performance nor low memory usage. In fact, it's way slower than it |
| could be and generates too much memory garbage. But since |
| performance is not an issue during intialization (and there is not |
| much time to improve it), I wrote it this way. If you don't like |
| it, go ahead and tune it up! |
| <P> |
| <DL> |
| <DT><B>Version: </B><DD>$Id: Configuration.java,v 1.34 2003/05/04 17:14:37 geirm Exp $</DD> |
| <DT><B>Author: </B><DD><a href="mailto:stefano@apache.org">Stefano Mazzocchi</a>, <a href="mailto:jon@latchkey.com">Jon S. Stevens</a>, <a href="mailto:daveb@miceda-data">Dave Bryson</a>, <a href="mailto:jvanzyl@apache.org">Jason van Zyl</a>, <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>, <a href="mailto:leon@opticode.co.za">Leon Messerschmidt</a>, <a href="mailto:kjohnson@transparent.com>Kent Johnson</a></DD> |
| <DT><B>See Also: </B><DD><A HREF="../../../../../serialized-form.html#org.apache.velocity.runtime.configuration.Configuration">Serialized Form</A></DL> |
| <HR> |
| |
| <P> |
| <!-- ======== INNER CLASS SUMMARY ======== --> |
| |
| <A NAME="inner_class_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Inner Class Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>(package private) class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.PropertiesReader.html">Configuration.PropertiesReader</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> This class is used to read properties lines.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>(package private) class</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.PropertiesTokenizer.html">Configuration.PropertiesTokenizer</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> This class divides into tokens a property value.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="inner_classes_inherited_from_class_java.util.Map"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Inner classes inherited from class java.util.Map</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>java.util.Map.Entry</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- =========== FIELD SUMMARY =========== --> |
| |
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Field Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#basePath">basePath</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Base path of the configuration file used to create |
| this Configuration object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private <A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#defaults">defaults</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Default configurations repository.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private org.apache.commons.collections.ExtendedProperties</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#deprecationCrutch">deprecationCrutch</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#file">file</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> The file connected to this repository (holding comments and |
| such).</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#fileSeparator">fileSeparator</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> File separator.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#include">include</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> This is the name of the property that can point to other |
| properties file for including other properties files.</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/apache/velocity/runtime/configuration/Configuration.html#isInitialized">isInitialized</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Has this configuration been intialized.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>protected java.util.ArrayList</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#keysAsListed">keysAsListed</A></B></CODE> |
| |
| <BR> |
| <B>Deprecated.</B> These are the keys in the order they listed |
| in the configuration file.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="fields_inherited_from_class_java.util.Hashtable"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Fields inherited from class java.util.Hashtable</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>count, emptyEnumerator, emptyIterator, ENTRIES, entrySet, KEYS, keySet, loadFactor, modCount, serialVersionUID, table, threshold, values, VALUES</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#Configuration()">Configuration</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Creates an empty extended properties object.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#Configuration(java.lang.String)">Configuration</A></B>(java.lang.String file)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Creates and loads the extended properties from the specified |
| file.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#Configuration(java.lang.String, java.lang.String)">Configuration</A></B>(java.lang.String file, |
| java.lang.String defaultFile)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Creates and loads the extended properties from the specified |
| file.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=2><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></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/apache/velocity/runtime/configuration/Configuration.html#addProperty(java.lang.String, java.lang.Object)">addProperty</A></B>(java.lang.String key, |
| java.lang.Object token)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Add a property to the configuration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#addStringProperty(java.lang.String, java.lang.String)">addStringProperty</A></B>(java.lang.String key, |
| java.lang.String token)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Sets a string property w/o checking for commas - used |
| internally when a property has been broken up into |
| strings that could contain escaped commas to prevent |
| the inadvertant vectorization.</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/apache/velocity/runtime/configuration/Configuration.html#clearProperty(java.lang.String)">clearProperty</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Clear a property in the configuration.</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/apache/velocity/runtime/configuration/Configuration.html#combine(org.apache.velocity.runtime.configuration.Configuration)">combine</A></B>(<A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A> c)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Combines an existing Hashtable with this Hashtable.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#convertProperties(java.util.Properties)">convertProperties</A></B>(java.util.Properties p)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Convert a standard properties class into a configuration |
| class.</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/apache/velocity/runtime/configuration/Configuration.html#display()">display</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Display the configuration for debugging |
| purposes.</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/apache/velocity/runtime/configuration/Configuration.html#getBoolean(java.lang.String)">getBoolean</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a boolean associated with the given configuration key.</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/apache/velocity/runtime/configuration/Configuration.html#getBoolean(java.lang.String, boolean)">getBoolean</A></B>(java.lang.String key, |
| boolean defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a boolean associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getBoolean(java.lang.String, java.lang.Boolean)">getBoolean</A></B>(java.lang.String key, |
| java.lang.Boolean defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a boolean associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> byte</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getByte(java.lang.String)">getByte</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a byte associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> byte</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getByte(java.lang.String, byte)">getByte</A></B>(java.lang.String key, |
| byte defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a byte associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Byte</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getByte(java.lang.String, java.lang.Byte)">getByte</A></B>(java.lang.String key, |
| java.lang.Byte defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a byte associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> double</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getDouble(java.lang.String)">getDouble</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a double associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> double</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getDouble(java.lang.String, double)">getDouble</A></B>(java.lang.String key, |
| double defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a double associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Double</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getDouble(java.lang.String, java.lang.Double)">getDouble</A></B>(java.lang.String key, |
| java.lang.Double defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a double associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> org.apache.commons.collections.ExtendedProperties</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getExtendedProperties()">getExtendedProperties</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> <I>Do not use. For deprecation assistance only.</I></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> float</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getFloat(java.lang.String)">getFloat</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a float associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> float</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getFloat(java.lang.String, float)">getFloat</A></B>(java.lang.String key, |
| float defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a float associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Float</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getFloat(java.lang.String, java.lang.Float)">getFloat</A></B>(java.lang.String key, |
| java.lang.Float defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a float associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getInclude()">getInclude</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Gets the property value for including other properties files.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getInt(java.lang.String)">getInt</A></B>(java.lang.String name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> The purpose of this method is to get the configuration resource |
| with the given name as an integer.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getInt(java.lang.String, int)">getInt</A></B>(java.lang.String name, |
| int def)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> The purpose of this method is to get the configuration resource |
| with the given name as an integer, or a default value.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getInteger(java.lang.String)">getInteger</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a int associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> int</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getInteger(java.lang.String, int)">getInteger</A></B>(java.lang.String key, |
| int defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a int associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Integer</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getInteger(java.lang.String, java.lang.Integer)">getInteger</A></B>(java.lang.String key, |
| java.lang.Integer defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a int associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getKeys()">getKeys</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get the list of the keys contained in the configuration |
| repository.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Iterator</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getKeys(java.lang.String)">getKeys</A></B>(java.lang.String prefix)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get the list of the keys contained in the configuration |
| repository that match the specified prefix.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getLong(java.lang.String)">getLong</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a long associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getLong(java.lang.String, long)">getLong</A></B>(java.lang.String key, |
| long defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a long associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Long</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getLong(java.lang.String, java.lang.Long)">getLong</A></B>(java.lang.String key, |
| java.lang.Long defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a long associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Properties</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getProperties(java.lang.String)">getProperties</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a list of properties associated with the given |
| configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Properties</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getProperties(java.lang.String, java.util.Properties)">getProperties</A></B>(java.lang.String key, |
| java.util.Properties defaults)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a list of properties associated with the given |
| configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Object</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getProperty(java.lang.String)">getProperty</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Gets a property from the configuration.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> short</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getShort(java.lang.String)">getShort</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a short associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> short</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getShort(java.lang.String, short)">getShort</A></B>(java.lang.String key, |
| short defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a short associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.Short</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getShort(java.lang.String, java.lang.Short)">getShort</A></B>(java.lang.String key, |
| java.lang.Short defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a short associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getString(java.lang.String)">getString</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a string associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getString(java.lang.String, java.lang.String)">getString</A></B>(java.lang.String key, |
| java.lang.String defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a string associated with the given configuration key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getStringArray(java.lang.String)">getStringArray</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get an array of strings associated with the given configuration |
| key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Vector</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getVector(java.lang.String)">getVector</A></B>(java.lang.String key)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a Vector of strings associated with the given configuration |
| key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.Vector</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#getVector(java.lang.String, java.util.Vector)">getVector</A></B>(java.lang.String key, |
| java.util.Vector defaultValue)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Get a Vector of strings associated with the given configuration |
| key.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>private void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#init(org.apache.velocity.runtime.configuration.Configuration)">init</A></B>(<A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A> exp)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Private initializer method that sets up the generic |
| resources.</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/apache/velocity/runtime/configuration/Configuration.html#isInitialized()">isInitialized</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Indicate to client code whether property |
| resources have been initialized or not.</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/apache/velocity/runtime/configuration/Configuration.html#load(java.io.InputStream)">load</A></B>(java.io.InputStream input)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Load the properties from the given input stream.</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/apache/velocity/runtime/configuration/Configuration.html#save(java.io.OutputStream, java.lang.String)">save</A></B>(java.io.OutputStream output, |
| java.lang.String Header)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Save the properties to the given outputstream.</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/apache/velocity/runtime/configuration/Configuration.html#setInclude(java.lang.String)">setInclude</A></B>(java.lang.String inc)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Sets the property value for including other properties files.</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/apache/velocity/runtime/configuration/Configuration.html#setProperty(java.lang.String, java.lang.Object)">setProperty</A></B>(java.lang.String key, |
| java.lang.Object value)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Set a property, this will replace any previously |
| set values.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#subset(java.lang.String)">subset</A></B>(java.lang.String prefix)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Create a Configurations object that is a subset |
| of this one.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html#testBoolean(java.lang.String)">testBoolean</A></B>(java.lang.String value)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Test whether the string represent by value maps to a boolean |
| value or not.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.util.Hashtable"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.util.Hashtable</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><clinit>, clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, getEnumeration, getIterator, hashCode, isEmpty, keys, keySet, put, putAll, readObject, rehash, remove, size, toString, values, writeObject</CODE></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TD><B>Methods inherited from class java.lang.Object</B></TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>finalize, getClass, notify, notifyAll, registerNatives, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ FIELD DETAIL =========== --> |
| |
| <A NAME="field_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Field Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="deprecationCrutch"><!-- --></A><H3> |
| deprecationCrutch</H3> |
| <PRE> |
| private org.apache.commons.collections.ExtendedProperties <B>deprecationCrutch</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> </DL> |
| <HR> |
| |
| <A NAME="defaults"><!-- --></A><H3> |
| defaults</H3> |
| <PRE> |
| private <A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A> <B>defaults</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Default configurations repository.</DL> |
| <HR> |
| |
| <A NAME="file"><!-- --></A><H3> |
| file</H3> |
| <PRE> |
| protected java.lang.String <B>file</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>The file connected to this repository (holding comments and |
| such).</DL> |
| <HR> |
| |
| <A NAME="basePath"><!-- --></A><H3> |
| basePath</H3> |
| <PRE> |
| protected java.lang.String <B>basePath</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Base path of the configuration file used to create |
| this Configuration object.</DL> |
| <HR> |
| |
| <A NAME="fileSeparator"><!-- --></A><H3> |
| fileSeparator</H3> |
| <PRE> |
| protected java.lang.String <B>fileSeparator</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>File separator.</DL> |
| <HR> |
| |
| <A NAME="isInitialized"><!-- --></A><H3> |
| isInitialized</H3> |
| <PRE> |
| protected boolean <B>isInitialized</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Has this configuration been intialized.</DL> |
| <HR> |
| |
| <A NAME="include"><!-- --></A><H3> |
| include</H3> |
| <PRE> |
| protected static java.lang.String <B>include</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>This is the name of the property that can point to other |
| properties file for including other properties files.</DL> |
| <HR> |
| |
| <A NAME="keysAsListed"><!-- --></A><H3> |
| keysAsListed</H3> |
| <PRE> |
| protected java.util.ArrayList <B>keysAsListed</B></PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>These are the keys in the order they listed |
| in the configuration file. This is useful when |
| you wish to perform operations with configuration |
| information in a particular order.</DL> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="Configuration()"><!-- --></A><H3> |
| Configuration</H3> |
| <PRE> |
| public <B>Configuration</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Creates an empty extended properties object.</DL> |
| <HR> |
| |
| <A NAME="Configuration(java.lang.String)"><!-- --></A><H3> |
| Configuration</H3> |
| <PRE> |
| public <B>Configuration</B>(java.lang.String file) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Creates and loads the extended properties from the specified |
| file.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>file</CODE> - A String.<DT><B>Throws:</B><DD><CODE>IOException.</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="Configuration(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| Configuration</H3> |
| <PRE> |
| public <B>Configuration</B>(java.lang.String file, |
| java.lang.String defaultFile) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Creates and loads the extended properties from the specified |
| file.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>file</CODE> - A String.<DT><B>Throws:</B><DD><CODE>IOException.</CODE> - </DL> |
| </DD> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%"> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TD COLSPAN=1><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TD> |
| </TR> |
| </TABLE> |
| |
| <A NAME="init(org.apache.velocity.runtime.configuration.Configuration)"><!-- --></A><H3> |
| init</H3> |
| <PRE> |
| private void <B>init</B>(<A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A> exp) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Private initializer method that sets up the generic |
| resources.<DD><DL> |
| <DT><B>Throws:</B><DD><CODE>IOException,</CODE> - if there was an I/O problem.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isInitialized()"><!-- --></A><H3> |
| isInitialized</H3> |
| <PRE> |
| public boolean <B>isInitialized</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Indicate to client code whether property |
| resources have been initialized or not.</DL> |
| <HR> |
| |
| <A NAME="getInclude()"><!-- --></A><H3> |
| getInclude</H3> |
| <PRE> |
| public java.lang.String <B>getInclude</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Gets the property value for including other properties files. |
| By default it is "include".<DD><DL> |
| <DT><B>Returns:</B><DD>A String.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setInclude(java.lang.String)"><!-- --></A><H3> |
| setInclude</H3> |
| <PRE> |
| public void <B>setInclude</B>(java.lang.String inc)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Sets the property value for including other properties files. |
| By default it is "include".<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>inc</CODE> - A String.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="load(java.io.InputStream)"><!-- --></A><H3> |
| load</H3> |
| <PRE> |
| public void <B>load</B>(java.io.InputStream input) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Load the properties from the given input stream.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>input</CODE> - An InputStream.<DT><B>Throws:</B><DD><CODE>IOException.</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperty(java.lang.String)"><!-- --></A><H3> |
| getProperty</H3> |
| <PRE> |
| public java.lang.Object <B>getProperty</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Gets a property from the configuration.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - property to retrieve<DT><B>Returns:</B><DD>value as object. Will return user value if exists, |
| if not then default value if exists, otherwise null</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| addProperty</H3> |
| <PRE> |
| public void <B>addProperty</B>(java.lang.String key, |
| java.lang.Object token)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Add a property to the configuration. If it already |
| exists then the value stated here will be added |
| to the configuration entry. For example, if |
| |
| resource.loader = file |
| |
| is already present in the configuration and you |
| |
| addProperty("resource.loader", "classpath") |
| |
| Then you will end up with a Vector like the |
| following: |
| |
| ["file", "classpath"]<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>String</CODE> - key<DD><CODE>String</CODE> - value</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addStringProperty(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| addStringProperty</H3> |
| <PRE> |
| private void <B>addStringProperty</B>(java.lang.String key, |
| java.lang.String token)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Sets a string property w/o checking for commas - used |
| internally when a property has been broken up into |
| strings that could contain escaped commas to prevent |
| the inadvertant vectorization. |
| |
| Thanks to Leon Messerschmidt for this one.</DL> |
| <HR> |
| |
| <A NAME="setProperty(java.lang.String, java.lang.Object)"><!-- --></A><H3> |
| setProperty</H3> |
| <PRE> |
| public void <B>setProperty</B>(java.lang.String key, |
| java.lang.Object value)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Set a property, this will replace any previously |
| set values. Set values is implicitly a call |
| to clearProperty(key), addProperty(key,value).<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>String</CODE> - key<DD><CODE>String</CODE> - value</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="save(java.io.OutputStream, java.lang.String)"><!-- --></A><H3> |
| save</H3> |
| <PRE> |
| public void <B>save</B>(java.io.OutputStream output, |
| java.lang.String Header) |
| throws java.io.IOException</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Save the properties to the given outputstream.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>output</CODE> - An OutputStream.<DD><CODE>header</CODE> - A String.<DT><B>Throws:</B><DD><CODE>IOException.</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="combine(org.apache.velocity.runtime.configuration.Configuration)"><!-- --></A><H3> |
| combine</H3> |
| <PRE> |
| public void <B>combine</B>(<A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A> c)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Combines an existing Hashtable with this Hashtable. |
| |
| Warning: It will overwrite previous entries without warning.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>Configuration</CODE> - </DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clearProperty(java.lang.String)"><!-- --></A><H3> |
| clearProperty</H3> |
| <PRE> |
| public void <B>clearProperty</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Clear a property in the configuration.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>String</CODE> - key to remove along with corresponding value.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKeys()"><!-- --></A><H3> |
| getKeys</H3> |
| <PRE> |
| public java.util.Iterator <B>getKeys</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get the list of the keys contained in the configuration |
| repository.<DD><DL> |
| <DT><B>Returns:</B><DD>An Iterator.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getKeys(java.lang.String)"><!-- --></A><H3> |
| getKeys</H3> |
| <PRE> |
| public java.util.Iterator <B>getKeys</B>(java.lang.String prefix)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get the list of the keys contained in the configuration |
| repository that match the specified prefix.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - The prefix to test against.<DT><B>Returns:</B><DD>An Iterator of keys that match the prefix.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="subset(java.lang.String)"><!-- --></A><H3> |
| subset</H3> |
| <PRE> |
| public <A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A> <B>subset</B>(java.lang.String prefix)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Create a Configurations object that is a subset |
| of this one. Take into account duplicate keys |
| by using the setProperty() in Configuration.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>String</CODE> - prefix</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="display()"><!-- --></A><H3> |
| display</H3> |
| <PRE> |
| public void <B>display</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Display the configuration for debugging |
| purposes.</DL> |
| <HR> |
| |
| <A NAME="getString(java.lang.String)"><!-- --></A><H3> |
| getString</H3> |
| <PRE> |
| public java.lang.String <B>getString</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a string associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated string.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a String.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getString(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getString</H3> |
| <PRE> |
| public java.lang.String <B>getString</B>(java.lang.String key, |
| java.lang.String defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a string associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated string if key is found, |
| default value otherwise.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a String.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperties(java.lang.String)"><!-- --></A><H3> |
| getProperties</H3> |
| <PRE> |
| public java.util.Properties <B>getProperties</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a list of properties associated with the given |
| configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated properties if key is found.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a String/Vector.<DD><CODE>java.lang.IllegalArgumentException</CODE> - if one of the tokens is |
| malformed (does not contain an equals sign).</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getProperties(java.lang.String, java.util.Properties)"><!-- --></A><H3> |
| getProperties</H3> |
| <PRE> |
| public java.util.Properties <B>getProperties</B>(java.lang.String key, |
| java.util.Properties defaults)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a list of properties associated with the given |
| configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated properties if key is found.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a String/Vector.<DD><CODE>java.lang.IllegalArgumentException</CODE> - if one of the tokens is |
| malformed (does not contain an equals sign).</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getStringArray(java.lang.String)"><!-- --></A><H3> |
| getStringArray</H3> |
| <PRE> |
| public java.lang.String[] <B>getStringArray</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get an array of strings associated with the given configuration |
| key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated string array if key is found.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a String/Vector.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVector(java.lang.String)"><!-- --></A><H3> |
| getVector</H3> |
| <PRE> |
| public java.util.Vector <B>getVector</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a Vector of strings associated with the given configuration |
| key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated Vector.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Vector.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getVector(java.lang.String, java.util.Vector)"><!-- --></A><H3> |
| getVector</H3> |
| <PRE> |
| public java.util.Vector <B>getVector</B>(java.lang.String key, |
| java.util.Vector defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a Vector of strings associated with the given configuration |
| key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated Vector.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Vector.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBoolean(java.lang.String)"><!-- --></A><H3> |
| getBoolean</H3> |
| <PRE> |
| public boolean <B>getBoolean</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a boolean associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated boolean.<DT><B>Throws:</B><DD><CODE>java.util.NoSuchElementException</CODE> - is thrown if the key doesn't |
| map to an existing object.<DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Boolean.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBoolean(java.lang.String, boolean)"><!-- --></A><H3> |
| getBoolean</H3> |
| <PRE> |
| public boolean <B>getBoolean</B>(java.lang.String key, |
| boolean defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a boolean associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated boolean.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Boolean.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getBoolean(java.lang.String, java.lang.Boolean)"><!-- --></A><H3> |
| getBoolean</H3> |
| <PRE> |
| public java.lang.Boolean <B>getBoolean</B>(java.lang.String key, |
| java.lang.Boolean defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a boolean associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated boolean if key is found and has valid |
| format, default value otherwise.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Boolean.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="testBoolean(java.lang.String)"><!-- --></A><H3> |
| testBoolean</H3> |
| <PRE> |
| public java.lang.String <B>testBoolean</B>(java.lang.String value)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Test whether the string represent by value maps to a boolean |
| value or not. We will allow <code>true</code>, <code>on</code>, |
| and <code>yes</code> for a <code>true</code> boolean value, and |
| <code>false</code>, <code>off</code>, and <code>no</code> for |
| <code>false</code> boolean values. Case of value to test for |
| boolean status is ignored.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>String</CODE> - The value to test for boolean state.<DT><B>Returns:</B><DD><code>true</code> or <code>false</code> if the supplied |
| text maps to a boolean value, or <code>null</code> otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getByte(java.lang.String)"><!-- --></A><H3> |
| getByte</H3> |
| <PRE> |
| public byte <B>getByte</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a byte associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated byte.<DT><B>Throws:</B><DD><CODE>java.util.NoSuchElementException</CODE> - is thrown if the key doesn't |
| map to an existing object.<DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Byte.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getByte(java.lang.String, byte)"><!-- --></A><H3> |
| getByte</H3> |
| <PRE> |
| public byte <B>getByte</B>(java.lang.String key, |
| byte defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a byte associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated byte.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Byte.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getByte(java.lang.String, java.lang.Byte)"><!-- --></A><H3> |
| getByte</H3> |
| <PRE> |
| public java.lang.Byte <B>getByte</B>(java.lang.String key, |
| java.lang.Byte defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a byte associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated byte if key is found and has valid |
| format, default value otherwise.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Byte.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getShort(java.lang.String)"><!-- --></A><H3> |
| getShort</H3> |
| <PRE> |
| public short <B>getShort</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a short associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated short.<DT><B>Throws:</B><DD><CODE>java.util.NoSuchElementException</CODE> - is thrown if the key doesn't |
| map to an existing object.<DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Short.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getShort(java.lang.String, short)"><!-- --></A><H3> |
| getShort</H3> |
| <PRE> |
| public short <B>getShort</B>(java.lang.String key, |
| short defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a short associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated short.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Short.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getShort(java.lang.String, java.lang.Short)"><!-- --></A><H3> |
| getShort</H3> |
| <PRE> |
| public java.lang.Short <B>getShort</B>(java.lang.String key, |
| java.lang.Short defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a short associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated short if key is found and has valid |
| format, default value otherwise.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Short.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInt(java.lang.String)"><!-- --></A><H3> |
| getInt</H3> |
| <PRE> |
| public int <B>getInt</B>(java.lang.String name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>The purpose of this method is to get the configuration resource |
| with the given name as an integer.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The resource name.<DT><B>Returns:</B><DD>The value of the resource as an integer.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInt(java.lang.String, int)"><!-- --></A><H3> |
| getInt</H3> |
| <PRE> |
| public int <B>getInt</B>(java.lang.String name, |
| int def)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>The purpose of this method is to get the configuration resource |
| with the given name as an integer, or a default value.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The resource name<DD><CODE>def</CODE> - The default value of the resource.<DT><B>Returns:</B><DD>The value of the resource as an integer.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInteger(java.lang.String)"><!-- --></A><H3> |
| getInteger</H3> |
| <PRE> |
| public int <B>getInteger</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a int associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated int.<DT><B>Throws:</B><DD><CODE>java.util.NoSuchElementException</CODE> - is thrown if the key doesn't |
| map to an existing object.<DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Integer.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInteger(java.lang.String, int)"><!-- --></A><H3> |
| getInteger</H3> |
| <PRE> |
| public int <B>getInteger</B>(java.lang.String key, |
| int defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a int associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated int.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Integer.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInteger(java.lang.String, java.lang.Integer)"><!-- --></A><H3> |
| getInteger</H3> |
| <PRE> |
| public java.lang.Integer <B>getInteger</B>(java.lang.String key, |
| java.lang.Integer defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a int associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated int if key is found and has valid |
| format, default value otherwise.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Integer.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLong(java.lang.String)"><!-- --></A><H3> |
| getLong</H3> |
| <PRE> |
| public long <B>getLong</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a long associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated long.<DT><B>Throws:</B><DD><CODE>java.util.NoSuchElementException</CODE> - is thrown if the key doesn't |
| map to an existing object.<DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Long.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLong(java.lang.String, long)"><!-- --></A><H3> |
| getLong</H3> |
| <PRE> |
| public long <B>getLong</B>(java.lang.String key, |
| long defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a long associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated long.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Long.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getLong(java.lang.String, java.lang.Long)"><!-- --></A><H3> |
| getLong</H3> |
| <PRE> |
| public java.lang.Long <B>getLong</B>(java.lang.String key, |
| java.lang.Long defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a long associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated long if key is found and has valid |
| format, default value otherwise.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Long.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFloat(java.lang.String)"><!-- --></A><H3> |
| getFloat</H3> |
| <PRE> |
| public float <B>getFloat</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a float associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated float.<DT><B>Throws:</B><DD><CODE>java.util.NoSuchElementException</CODE> - is thrown if the key doesn't |
| map to an existing object.<DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Float.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFloat(java.lang.String, float)"><!-- --></A><H3> |
| getFloat</H3> |
| <PRE> |
| public float <B>getFloat</B>(java.lang.String key, |
| float defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a float associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated float.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Float.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getFloat(java.lang.String, java.lang.Float)"><!-- --></A><H3> |
| getFloat</H3> |
| <PRE> |
| public java.lang.Float <B>getFloat</B>(java.lang.String key, |
| java.lang.Float defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a float associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated float if key is found and has valid |
| format, default value otherwise.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Float.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDouble(java.lang.String)"><!-- --></A><H3> |
| getDouble</H3> |
| <PRE> |
| public double <B>getDouble</B>(java.lang.String key)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a double associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DT><B>Returns:</B><DD>The associated double.<DT><B>Throws:</B><DD><CODE>java.util.NoSuchElementException</CODE> - is thrown if the key doesn't |
| map to an existing object.<DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Double.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDouble(java.lang.String, double)"><!-- --></A><H3> |
| getDouble</H3> |
| <PRE> |
| public double <B>getDouble</B>(java.lang.String key, |
| double defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a double associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated double.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Double.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDouble(java.lang.String, java.lang.Double)"><!-- --></A><H3> |
| getDouble</H3> |
| <PRE> |
| public java.lang.Double <B>getDouble</B>(java.lang.String key, |
| java.lang.Double defaultValue)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Get a double associated with the given configuration key.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - The configuration key.<DD><CODE>defaultValue</CODE> - The default value.<DT><B>Returns:</B><DD>The associated double if key is found and has valid |
| format, default value otherwise.<DT><B>Throws:</B><DD><CODE>ClassCastException</CODE> - is thrown if the key maps to an |
| object that is not a Double.<DD><CODE>java.lang.NumberFormatException</CODE> - is thrown if the value mapped |
| by the key has not a valid number format.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="convertProperties(java.util.Properties)"><!-- --></A><H3> |
| convertProperties</H3> |
| <PRE> |
| public static <A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.html">Configuration</A> <B>convertProperties</B>(java.util.Properties p)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Convert a standard properties class into a configuration |
| class.<DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>Properties</CODE> - properties object to convert into |
| a Configuration object.<DT><B>Returns:</B><DD>Configuration configuration created from the |
| properties object.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getExtendedProperties()"><!-- --></A><H3> |
| getExtendedProperties</H3> |
| <PRE> |
| public org.apache.commons.collections.ExtendedProperties <B>getExtendedProperties</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <I>Do not use. For deprecation assistance only.</I> |
| <P> |
| <DD><p> |
| Routine intended for deprecation period only |
| as we switch from using the Configuration |
| class in Velocity to the Jakarta Commons |
| ExtendedProperties |
| </p> |
| <p> |
| Do not use this for general use. It will disappear |
| </p><DD><DL> |
| <DT><B>Returns:</B><DD>ExtendedProperties containing data of Configuration</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| <!-- ========== START OF NAVBAR ========== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0"> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3"> |
| <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="class-use/Configuration.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </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"> |
| PREV CLASS |
| <A HREF="../../../../../org/apache/velocity/runtime/configuration/Configuration.PropertiesReader.html"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A> |
| <A HREF="Configuration.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: <A HREF="#inner_class_summary">INNER</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> |
| <!-- =========== END OF NAVBAR =========== --> |
| |
| <HR> |
| Copyright © 2002 Apache Software Foundation. All Rights Reserved. |
| </BODY> |
| </HTML> |
