| <!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:18 PST 2005 -->
|
| <TITLE>
|
| ParameterParser (Velocity Tools 1.2 Documentation)
|
| </TITLE>
|
|
|
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.tools.ParameterParser class">
|
|
|
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">
|
|
|
| <SCRIPT type="text/javascript">
|
| function windowTitle()
|
| {
|
| parent.document.title="ParameterParser (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/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools"><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="ParameterParser.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.view.tools</FONT>
|
| <BR>
|
| Class ParameterParser</H2>
|
| <PRE>
|
| java.lang.Object
|
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">org.apache.velocity.tools.generic.ValueParser</A>
|
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.velocity.tools.view.tools.ParameterParser</B>
|
| </PRE>
|
| <DL>
|
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public class <B>ParameterParser</B><DT>extends <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A><DT>implements <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></DL>
|
|
|
| <P>
|
| <p>Utility class for easy parsing of <CODE>ServletRequest</CODE> parameters.</p> |
| <p><pre> |
| Template example(s): |
| $params.foo -> bar |
| $params.getNumber('baz') -> 12.6 |
| $params.getInt('baz') -> 12 |
| $params.getNumbers('foo') -> [12.6] |
| |
| Toolbox configuration: |
| <tool> |
| <key>params</key> |
| <scope>request</scope> |
| <class>org.apache.velocity.tools.view.tools.ParameterParser</class> |
| </tool> |
| </pre></p> |
| |
| <p>When used as a view tool, this should only be used in the request scope. |
| This class is, however, quite useful in your application's controller, filter, |
| or action code as well as in templates.</p>
|
| <P>
|
|
|
| <P>
|
| <DL>
|
| <DT><B>Version:</B></DT> |
| <DD>$Revision: 326942 $ $Date: 2005-10-20 09:47:19 -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 javax.servlet.ServletRequest</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#request">request</A></B></CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="fields_inherited_from_class_org.apache.velocity.tools.generic.ValueParser"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Fields inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE></CODE></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/view/tools/ParameterParser.html#ParameterParser()">ParameterParser</A></B>()</CODE>
|
|
|
| <BR>
|
| Constructs a new instance</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#ParameterParser(javax.servlet.ServletRequest)">ParameterParser</A></B>(javax.servlet.ServletRequest request)</CODE>
|
|
|
| <BR>
|
| Constructs a new instance using the specified request.</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>protected javax.servlet.ServletRequest</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ParameterParser.html#getRequest()">getRequest</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns the current <CODE>ServletRequest</CODE> for this instance.</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/view/tools/ParameterParser.html#getSource()">getSource</A></B>()</CODE>
|
|
|
| <BR>
|
| Overrides ValueParser.getSource() to return the result |
| of getRequest().getParameterMap() if Servlet 2.3 or above |
| is being used.</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/view/tools/ParameterParser.html#getString(java.lang.String)">getString</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| Overrides ValueParser.getString(String key) to retrieve the |
| String from the ServletRequest instead of an arbitrary Map.</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/view/tools/ParameterParser.html#getStrings(java.lang.String)">getStrings</A></B>(java.lang.String key)</CODE>
|
|
|
| <BR>
|
| Overrides ValueParser.getString(String key) to retrieve |
| Strings from the ServletRequest instead of an arbitrary Map.</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/tools/view/tools/ParameterParser.html#init(java.lang.Object)">init</A></B>(java.lang.Object obj)</CODE>
|
|
|
| <BR>
|
| Initializes this instance.</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/view/tools/ParameterParser.html#setRequest(javax.servlet.ServletRequest)">setRequest</A></B>(javax.servlet.ServletRequest request)</CODE>
|
|
|
| <BR>
|
| Sets the current <CODE>ServletRequest</CODE></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/view/tools/ParameterParser.html#setSource(java.util.Map)">setSource</A></B>(java.util.Map source)</CODE>
|
|
|
| <BR>
|
| Overrides ValueParser.setSource(Map source) to throw an |
| UnsupportedOperationException, because this class uses |
| a servlet request as its source, not a Map.</TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_org.apache.velocity.tools.generic.ValueParser"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class org.apache.velocity.tools.generic.<A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#exists(java.lang.String)">exists</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#get(java.lang.String)">get</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getBoolean(java.lang.String)">getBoolean</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getBoolean(java.lang.String, boolean)">getBoolean</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getBoolean(java.lang.String, java.lang.Boolean)">getBoolean</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getBooleans(java.lang.String)">getBooleans</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getDouble(java.lang.String, double)">getDouble</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getDoubles(java.lang.String)">getDoubles</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getInt(java.lang.String, int)">getInt</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getInts(java.lang.String)">getInts</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getNumber(java.lang.String)">getNumber</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getNumber(java.lang.String, java.lang.Number)">getNumber</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getNumbers(java.lang.String)">getNumbers</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getString(java.lang.String, java.lang.String)">getString</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#parseBoolean(java.lang.String)">parseBoolean</A>, <A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#parseNumber(java.lang.String)">parseNumber</A></CODE></TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <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="request"><!-- --></A><H3>
|
| request</H3>
|
| <PRE>
|
| private javax.servlet.ServletRequest <B>request</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="ParameterParser()"><!-- --></A><H3>
|
| ParameterParser</H3>
|
| <PRE>
|
| public <B>ParameterParser</B>()</PRE>
|
| <DL>
|
| <DD>Constructs a new instance
|
| <P>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="ParameterParser(javax.servlet.ServletRequest)"><!-- --></A><H3>
|
| ParameterParser</H3>
|
| <PRE>
|
| public <B>ParameterParser</B>(javax.servlet.ServletRequest request)</PRE>
|
| <DL>
|
| <DD>Constructs a new instance using the specified request.
|
| <P>
|
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the <CODE>ServletRequest</CODE> to be parsed</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="init(java.lang.Object)"><!-- --></A><H3>
|
| init</H3>
|
| <PRE>
|
| public void <B>init</B>(java.lang.Object obj)</PRE>
|
| <DL>
|
| <DD>Initializes this instance.
|
| <P>
|
| <DD><DL>
|
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html#init(java.lang.Object)">init</A></CODE> in interface <CODE><A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewTool.html" title="interface in org.apache.velocity.tools.view.tools">ViewTool</A></CODE></DL>
|
| </DD>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the current ViewContext or ServletRequest |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.IllegalArgumentException</CODE> - if the param is not a |
| ViewContext or ServletRequest</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setRequest(javax.servlet.ServletRequest)"><!-- --></A><H3>
|
| setRequest</H3>
|
| <PRE>
|
| protected void <B>setRequest</B>(javax.servlet.ServletRequest request)</PRE>
|
| <DL>
|
| <DD>Sets the current <CODE>ServletRequest</CODE>
|
| <P>
|
| <DD><DL>
|
| </DL>
|
| </DD>
|
| <DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>request</CODE> - the <CODE>ServletRequest</CODE> to be parsed</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getRequest()"><!-- --></A><H3>
|
| getRequest</H3>
|
| <PRE>
|
| protected javax.servlet.ServletRequest <B>getRequest</B>()</PRE>
|
| <DL>
|
| <DD>Returns the current <CODE>ServletRequest</CODE> for this instance.
|
| <P>
|
| <DD><DL>
|
| </DL>
|
| </DD>
|
| <DD><DL>
|
| |
| <DT><B>Returns:</B><DD>the current <CODE>ServletRequest</CODE> |
| <DT><B>Throws:</B> |
| <DD><CODE>java.lang.UnsupportedOperationException</CODE> - if the request is null</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>Overrides ValueParser.getString(String key) to retrieve the |
| String from the ServletRequest instead of an arbitrary Map.
|
| <P>
|
| <DD><DL>
|
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getString(java.lang.String)">getString</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></CODE></DL>
|
| </DD>
|
| <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="getStrings(java.lang.String)"><!-- --></A><H3>
|
| getStrings</H3>
|
| <PRE>
|
| public java.lang.String[] <B>getStrings</B>(java.lang.String key)</PRE>
|
| <DL>
|
| <DD>Overrides ValueParser.getString(String key) to retrieve |
| Strings from the ServletRequest instead of an arbitrary Map.
|
| <P>
|
| <DD><DL>
|
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getStrings(java.lang.String)">getStrings</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></CODE></DL>
|
| </DD>
|
| <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 |
| the given request parameter has, or <code>null</code> |
| if the parameter does not exist</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setSource(java.util.Map)"><!-- --></A><H3>
|
| setSource</H3>
|
| <PRE>
|
| protected void <B>setSource</B>(java.util.Map source)</PRE>
|
| <DL>
|
| <DD>Overrides ValueParser.setSource(Map source) to throw an |
| UnsupportedOperationException, because this class uses |
| a servlet request as its source, not a Map.
|
| <P>
|
| <DD><DL>
|
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#setSource(java.util.Map)">setSource</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></CODE></DL>
|
| </DD>
|
| <DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getSource()"><!-- --></A><H3>
|
| getSource</H3>
|
| <PRE>
|
| protected java.util.Map <B>getSource</B>()</PRE>
|
| <DL>
|
| <DD>Overrides ValueParser.getSource() to return the result |
| of getRequest().getParameterMap() if Servlet 2.3 or above |
| is being used. Otherwise, this throws an |
| UnsupportedOperationException, because the class uses a |
| servlet request as its source, not a Map.
|
| <P>
|
| <DD><DL>
|
| <DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html#getSource()">getSource</A></CODE> in class <CODE><A HREF="../../../../../../org/apache/velocity/tools/generic/ValueParser.html" title="class in org.apache.velocity.tools.generic">ValueParser</A></CODE></DL>
|
| </DD>
|
| <DD><DL>
|
| </DL>
|
| </DD>
|
| </DL>
|
| <!-- ========= END OF CLASS DATA ========= -->
|
| <HR>
|
|
|
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== -->
|
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
| <TR>
|
| <TD COLSPAN=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/view/tools/LinkTool.QueryPair.html" title="class in org.apache.velocity.tools.view.tools"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../../../org/apache/velocity/tools/view/tools/ViewRenderTool.html" title="class in org.apache.velocity.tools.view.tools"><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="ParameterParser.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>
|