Java Doc for ParameterParser.java in  » Template-Engine » Velocity » org » apache » velocity » tools » view » tools » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Template Engine » Velocity » org.apache.velocity.tools.view.tools 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.velocity.tools.generic.ValueParser
      org.apache.velocity.tools.view.tools.ParameterParser

ParameterParser
public class ParameterParser extends ValueParser (Code)

Utility class for easy parsing of ServletRequest parameters.

 Template example(s):
 $params.foo                ->  bar
 $params.getNumber('baz')   ->  12.6
 $params.getInt('baz')      ->  12
 $params.getNumbers('baz')  ->  [12.6]
 Toolbox configuration:
 <tool>
 <key>params</key>
 <scope>request</scope>
 <class>org.apache.velocity.tools.view.tools.ParameterParser</class>
 </tool>
 

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.


author:
   Nathan Bubna
version:
   $Revision: 483666 $ $Date: 2006-12-07 13:04:59 -0800 (Thu, 07 Dec 2006) $



Constructor Summary
public  ParameterParser()
    
public  ParameterParser(ServletRequest request)
     Constructs a new instance using the specified request.

Method Summary
public  MapgetAll()
     Returns the map of all parameters available for the current request.
protected  ServletRequestgetRequest()
     Returns the current ServletRequest for this instance.
protected  MapgetSource()
     Overrides ValueParser.getSource() to return the result of getRequest().getParameterMap().
public  StringgetString(String key)
     Overrides ValueParser.getString(String key) to retrieve the String from the ServletRequest instead of an arbitrary Map.
public  String[]getStrings(String key)
     Overrides ValueParser.getString(String key) to retrieve Strings from the ServletRequest instead of an arbitrary Map.
public  voidinit(Object obj)
     Initializes this instance.
protected  voidsetRequest(ServletRequest request)
    
protected  voidsetSource(Map source)
     Overrides ValueParser.setSource(Map source) to throw an UnsupportedOperationException, because this class uses a servlet request as its source, not a Map.


Constructor Detail
ParameterParser
public ParameterParser()(Code)
Constructs a new instance



ParameterParser
public ParameterParser(ServletRequest request)(Code)
Constructs a new instance using the specified request.
Parameters:
  request - the ServletRequest to be parsed




Method Detail
getAll
public Map getAll()(Code)
Returns the map of all parameters available for the current request.



getRequest
protected ServletRequest getRequest()(Code)
Returns the current ServletRequest for this instance. the current ServletRequest
throws:
  UnsupportedOperationException - if the request is null



getSource
protected Map getSource()(Code)
Overrides ValueParser.getSource() to return the result of getRequest().getParameterMap().



getString
public String getString(String key)(Code)
Overrides ValueParser.getString(String key) to retrieve the String from the ServletRequest instead of an arbitrary Map.
Parameters:
  key - the parameter's key parameter matching the specified key ornull if there is no matchingparameter



getStrings
public String[] getStrings(String key)(Code)
Overrides ValueParser.getString(String key) to retrieve Strings from the ServletRequest instead of an arbitrary Map.
Parameters:
  key - the key for the desired parameter an array of String objects containing all of the valuesthe given request parameter has, or nullif the parameter does not exist



init
public void init(Object obj)(Code)
Initializes this instance.
Parameters:
  obj - the current ViewContext or ServletRequest
throws:
  IllegalArgumentException - if the param is not aViewContext or ServletRequest



setRequest
protected void setRequest(ServletRequest request)(Code)
Sets the current ServletRequest
Parameters:
  request - the ServletRequest to be parsed



setSource
protected void setSource(Map source)(Code)
Overrides ValueParser.setSource(Map source) to throw an UnsupportedOperationException, because this class uses a servlet request as its source, not a Map.



Methods inherited from org.apache.velocity.tools.generic.ValueParser
public boolean exists(String key)(Code)(Java Doc)
public Object get(String key)(Code)(Java Doc)
public Boolean getBoolean(String key)(Code)(Java Doc)
public boolean getBoolean(String key, boolean alternate)(Code)(Java Doc)
public Boolean getBoolean(String key, Boolean alternate)(Code)(Java Doc)
public Boolean[] getBooleans(String key)(Code)(Java Doc)
public Double getDouble(String key)(Code)(Java Doc)
public Double getDouble(String key, Double alternate)(Code)(Java Doc)
public double getDouble(String key, double alternate)(Code)(Java Doc)
public double[] getDoubles(String key)(Code)(Java Doc)
public int getInt(String key, int alternate)(Code)(Java Doc)
public Integer getInteger(String key)(Code)(Java Doc)
public Integer getInteger(String key, Integer alternate)(Code)(Java Doc)
public int[] getInts(String key)(Code)(Java Doc)
public Locale getLocale(String key)(Code)(Java Doc)
public Locale getLocale(String key, Locale alternate)(Code)(Java Doc)
public Locale[] getLocales(String key)(Code)(Java Doc)
public Number getNumber(String key)(Code)(Java Doc)
public Number getNumber(String key, Number alternate)(Code)(Java Doc)
public Number[] getNumbers(String key)(Code)(Java Doc)
protected Map getSource()(Code)(Java Doc)
public String getString(String key)(Code)(Java Doc)
public String getString(String key, String alternate)(Code)(Java Doc)
public String[] getStrings(String key)(Code)(Java Doc)
final protected String getStringsDelimiter()(Code)(Java Doc)
protected Boolean parseBoolean(String value)(Code)(Java Doc)
protected Locale parseLocale(String value)(Code)(Java Doc)
protected Number parseNumber(String value) throws NumberFormatException(Code)(Java Doc)
protected String[] parseStringList(String value)(Code)(Java Doc)
protected void setSource(Map source)(Code)(Java Doc)
final protected void setStringsDelimiter(String delimiter)(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.