| <!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.4.2_08) on Mon Nov 14 10:15:17 PST 2005 -->
|
| <TITLE>
|
| ValueParser (Velocity Tools 1.2 Documentation)
|
| </TITLE>
|
|
|
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.generic.ValueParser class">
|
|
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
|
|
|
| <SCRIPT type="text/javascript">
|
| function windowTitle()
|
| {
|
| parent.document.title="ValueParser (Velocity Tools 1.2 Documentation)";
|
| }
|
| </SCRIPT>
|
|
|
| </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=3 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/generic/SortTool.PropertiesComparator.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
|
| NEXT CLASS</FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
| <A HREF="ValueParser.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.generic</FONT>
|
| <BR>
|
| Class ValueParser</H2>
|
| <PRE>
|
| java.lang.Object
|
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.generic.ValueParser</B>
|
| </PRE>
|
| <DL>
|
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html" title="class in org.apache.velocity.tools.view.tools">ParameterParser</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public class <B>ValueParser</B><DT>extends java.lang.Object</DL>
|
|
|
| <P>
|
| <p>Utility class for easy parsing of String values held in a Map.</p> |
| <p><pre> |
| Template example(s): |
| $parser.foo -> bar |
| $parser.getNumber('baz') -> 12.6 |
| $parser.getInt('baz') -> 12 |
| $parser.getNumbers('foo') -> [12.6] |
| |
| Toolbox configuration: |
| <tool> |
| <key>parser</key> |
| <class>org.apache.velocity.generic.Parser</class> |
| </tool> |
| </pre></p> |
| |
| <p>This comes in very handy when parsing parameters.</p>
|
| <P>
|
|
|
| <P>
|
| <DL>
|
| <DT><B>Since:</B></DT> |
| <DD>VelocityTools 1.2</DD> |
| <DT><B>Version:</B></DT> |
| <DD>$Revision: 326944 $ $Date: 2005-10-20 09:48:02 -0700 (Thu, 20 Oct 2005) $</DD> |
| <DT><B>Author:</B></DT> |
| <DD><a href="mailto:nathan@esha.com">Nathan Bubna</a></DD> |
| </DL>
|
| <HR>
|
|
|
| <P>
|
| <!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
|
| <!-- =========== FIELD SUMMARY =========== -->
|
|
|
| <A NAME="field_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <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>private java.util.Map</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#source">source</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">
|
| <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/tools/generic/ValueParser.html#ValueParser()">ValueParser</A></B>()</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#ValueParser(java.util.Map)">ValueParser</A></B>(java.util.Map source)</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">
|
| <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> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#exists(java.lang.String)">exists</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| Convenience method for checking whether a certain parameter exists.</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/tools/generic/ValueParser.html#get(java.lang.String)">get</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| Convenience method for use in Velocity templates.</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/tools/generic/ValueParser.html#getBoolean(java.lang.String)">getBoolean</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getBoolean(java.lang.String, boolean)">getBoolean</A></B>(java.lang.String key, |
| boolean alternate)</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getBoolean(java.lang.String, java.lang.Boolean)">getBoolean</A></B>(java.lang.String key, |
| java.lang.Boolean alternate)</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getBooleans(java.lang.String)">getBooleans</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getDouble(java.lang.String, double)">getDouble</A></B>(java.lang.String key, |
| double alternate)</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getDoubles(java.lang.String)">getDoubles</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getInt(java.lang.String, int)">getInt</A></B>(java.lang.String key, |
| int alternate)</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getInts(java.lang.String)">getInts</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.Number</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#getNumber(java.lang.String)">getNumber</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.Number</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#getNumber(java.lang.String, java.lang.Number)">getNumber</A></B>(java.lang.String key, |
| java.lang.Number alternate)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.lang.Number[]</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#getNumbers(java.lang.String)">getNumbers</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>protected java.util.Map</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#getSource()">getSource</A></B>()</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getString(java.lang.String)">getString</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getString(java.lang.String, java.lang.String)">getString</A></B>(java.lang.String key, |
| java.lang.String alternate)</CODE>
|
|
|
| <BR>
|
| </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/tools/generic/ValueParser.html#getStrings(java.lang.String)">getStrings</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>protected java.lang.Boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#parseBoolean(java.lang.String)">parseBoolean</A></B>(java.lang.String value)</CODE>
|
|
|
| <BR>
|
| Converts a parameter value into a <CODE>Boolean</CODE> |
| Sub-classes can override to allow for customized boolean parsing.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>protected java.lang.Number</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#parseNumber(java.lang.String)">parseNumber</A></B>(java.lang.String value)</CODE>
|
|
|
| <BR>
|
| Converts a parameter value into a <CODE>Number</CODE> |
| This is used as the base for all numeric parsing methods.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE>protected void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/generic/ValueParser.html#setSource(java.util.Map)">setSource</A></B>(java.util.Map source)</CODE>
|
|
|
| <BR>
|
| </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">
|
| <TD><B>Methods inherited from class java.lang.Object</B></TD>
|
| </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">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Field Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="source"><!-- --></A><H3>
|
| source</H3>
|
| <PRE>
|
| private java.util.Map <B>source</B></PRE>
|
| <DL>
|
| <DL>
|
| </DL>
|
| </DL>
|
|
|
| <!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
|
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Constructor Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="ValueParser()"><!-- --></A><H3>
|
| ValueParser</H3>
|
| <PRE>
|
| public <B>ValueParser</B>()</PRE>
|
| <DL>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="ValueParser(java.util.Map)"><!-- --></A><H3>
|
| ValueParser</H3>
|
| <PRE>
|
| public <B>ValueParser</B>(java.util.Map source)</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">
|
| <TD COLSPAN=1><FONT SIZE="+2">
|
| <B>Method Detail</B></FONT></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <A NAME="setSource(java.util.Map)"><!-- --></A><H3>
|
| setSource</H3>
|
| <PRE>
|
| protected void <B>setSource</B>(java.util.Map source)</PRE>
|
| <DL>
|
| <DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getSource()"><!-- --></A><H3>
|
| getSource</H3>
|
| <PRE>
|
| protected java.util.Map <B>getSource</B>()</PRE>
|
| <DL>
|
| <DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="exists(java.lang.String)"><!-- --></A><H3>
|
| exists</H3>
|
| <PRE>
|
| public boolean <B>exists</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD>Convenience method for checking whether a certain parameter exists.
|
| <P>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter's key |
| <DT><B>Returns:</B><DD><code>true</code> if a parameter exists for the specified |
| key; otherwise, returns <code>false</code>.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="get(java.lang.String)"><!-- --></A><H3>
|
| get</H3>
|
| <PRE>
|
| public java.lang.String <B>get</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD>Convenience method for use in Velocity templates. |
| This allows for easy "dot" access to parameters. |
| |
| e.g. $params.foo instead of $params.getString('foo')
|
| <P>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter's key |
| <DT><B>Returns:</B><DD>parameter matching the specified key or |
| <code>null</code> if there is no matching |
| parameter</DL>
|
| </DD>
|
| </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><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter's key |
| <DT><B>Returns:</B><DD>parameter matching the specified key or |
| <code>null</code> if there is no matching |
| parameter</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 alternate)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate value |
| <DT><B>Returns:</B><DD>parameter matching the specified key or the |
| specified alternate String if there is no matching |
| parameter</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getBoolean(java.lang.String)"><!-- --></A><H3>
|
| getBoolean</H3>
|
| <PRE>
|
| public java.lang.Boolean <B>getBoolean</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key |
| <DT><B>Returns:</B><DD>a <CODE>Boolean</CODE> object for the specified key or |
| <code>null</code> if no matching parameter is found</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 alternate)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate boolean value |
| <DT><B>Returns:</B><DD>boolean value for the specified key or the |
| alternate boolean is no value is found</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 alternate)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - the alternate <CODE>Boolean</CODE> |
| <DT><B>Returns:</B><DD>a <CODE>Boolean</CODE> for the specified key or the specified |
| alternate if no matching parameter is found</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNumber(java.lang.String)"><!-- --></A><H3>
|
| getNumber</H3>
|
| <PRE>
|
| public java.lang.Number <B>getNumber</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key |
| <DT><B>Returns:</B><DD>a <CODE>Number</CODE> for the specified key or |
| <code>null</code> if no matching parameter is found</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNumber(java.lang.String, java.lang.Number)"><!-- --></A><H3>
|
| getNumber</H3>
|
| <PRE>
|
| public java.lang.Number <B>getNumber</B>(java.lang.String key, |
| java.lang.Number alternate)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate Number |
| <DT><B>Returns:</B><DD>a Number for the specified key or the specified |
| alternate if no matching parameter is found</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getInt(java.lang.String, int)"><!-- --></A><H3>
|
| getInt</H3>
|
| <PRE>
|
| public int <B>getInt</B>(java.lang.String key, |
| int alternate)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate int value |
| <DT><B>Returns:</B><DD>the int value for the specified key or the specified |
| alternate value if no matching parameter is found</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 alternate)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the desired parameter's key<DD><CODE>alternate</CODE> - The alternate double value |
| <DT><B>Returns:</B><DD>the double value for the specified key or the specified |
| alternate value if no matching parameter is found</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getStrings(java.lang.String)"><!-- --></A><H3>
|
| getStrings</H3>
|
| <PRE>
|
| public java.lang.String[] <B>getStrings</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter |
| <DT><B>Returns:</B><DD>an array of String objects containing all of the values |
| associated with the given key, or <code>null</code> |
| if the no values are associated with the given key</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getBooleans(java.lang.String)"><!-- --></A><H3>
|
| getBooleans</H3>
|
| <PRE>
|
| public java.lang.Boolean[] <B>getBooleans</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter |
| <DT><B>Returns:</B><DD>an array of Boolean objects associated with the given key.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getNumbers(java.lang.String)"><!-- --></A><H3>
|
| getNumbers</H3>
|
| <PRE>
|
| public java.lang.Number[] <B>getNumbers</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter |
| <DT><B>Returns:</B><DD>an array of Number objects associated with the given key, |
| or <code>null</code> if Numbers are not associated with it.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getInts(java.lang.String)"><!-- --></A><H3>
|
| getInts</H3>
|
| <PRE>
|
| public int[] <B>getInts</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter |
| <DT><B>Returns:</B><DD>an array of int values associated with the given key, |
| or <code>null</code> if numbers are not associated with it.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getDoubles(java.lang.String)"><!-- --></A><H3>
|
| getDoubles</H3>
|
| <PRE>
|
| public double[] <B>getDoubles</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>key</CODE> - the key for the desired parameter |
| <DT><B>Returns:</B><DD>an array of double values associated with the given key, |
| or <code>null</code> if numbers are not associated with it.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="parseNumber(java.lang.String)"><!-- --></A><H3>
|
| parseNumber</H3>
|
| <PRE>
|
| protected java.lang.Number <B>parseNumber</B>(java.lang.String value) |
| throws java.lang.NumberFormatException</PRE>
|
| <DL>
|
| <DD>Converts a parameter value into a <CODE>Number</CODE> |
| This is used as the base for all numeric parsing methods. So, |
| sub-classes can override to allow for customized number parsing. |
| (e.g. to handle fractions, compound numbers, etc.)
|
| <P>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the string to be parsed |
| <DT><B>Returns:</B><DD>the value as a <CODE>Number</CODE> |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.NumberFormatException</CODE></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="parseBoolean(java.lang.String)"><!-- --></A><H3>
|
| parseBoolean</H3>
|
| <PRE>
|
| protected java.lang.Boolean <B>parseBoolean</B>(java.lang.String value)</PRE>
|
| <DL>
|
| <DD>Converts a parameter value into a <CODE>Boolean</CODE> |
| Sub-classes can override to allow for customized boolean parsing. |
| (e.g. to handle "Yes/No" or "T/F")
|
| <P>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>value</CODE> - the string to be parsed |
| <DT><B>Returns:</B><DD>the value as a <CODE>Boolean</CODE></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=3 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/generic/SortTool.PropertiesComparator.html" title="class in org.apache.velocity.tools.generic"><B>PREV CLASS</B></A>
|
| NEXT CLASS</FONT></TD>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A>
|
| <A HREF="ValueParser.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 Apache Software Foundation
|
| </BODY>
|
| </HTML>
|
