|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.velocity.tools.view.tools.ParameterParser
Utility class for easy parsing of ServletRequest
parameters.
This class implements the ViewTool interface to allow it to be used as a request scoped tool.
It should be noted that this class is not thread-safe. As it is wholly dependent upon the current ServletRequest, therefore each ServletRequest should have its own instance. This tool should not be used in the session or application scopes of your webapp.
Field Summary | |
private javax.servlet.ServletRequest |
request
|
Constructor Summary | |
ParameterParser()
Constructs a new instance |
|
ParameterParser(javax.servlet.ServletRequest request)
Constructs a new instance using the specified request. |
Method Summary | |
boolean |
exists(java.lang.String key)
Convenience method for checking whether a certain parameter exists. |
java.lang.String |
get(java.lang.String key)
Convenience method for use in Velocity templates. |
java.lang.Boolean |
getBoolean(java.lang.String key)
|
boolean |
getBoolean(java.lang.String key,
boolean alternate)
|
java.lang.Boolean |
getBoolean(java.lang.String key,
java.lang.Boolean alternate)
|
double |
getDouble(java.lang.String key,
double alternate)
|
double[] |
getDoubles(java.lang.String key)
|
int |
getInt(java.lang.String key,
int alternate)
|
int[] |
getInts(java.lang.String key)
|
java.lang.Number |
getNumber(java.lang.String key)
|
java.lang.Number |
getNumber(java.lang.String key,
java.lang.Number alternate)
|
java.lang.Number[] |
getNumbers(java.lang.String key)
|
protected javax.servlet.ServletRequest |
getRequest()
Returns the current ServletRequest for this instance. |
java.lang.String |
getString(java.lang.String key)
|
java.lang.String |
getString(java.lang.String key,
java.lang.String alternate)
|
java.lang.String[] |
getStrings(java.lang.String key)
|
void |
init(java.lang.Object obj)
Initializes this instance. |
protected java.lang.Number |
parseNumber(java.lang.String value)
Converts a parameter value into a Number
This is used as the base for all numeric parsing methods. |
protected void |
setRequest(javax.servlet.ServletRequest request)
Sets the current ServletRequest |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
private javax.servlet.ServletRequest request
Constructor Detail |
public ParameterParser()
public ParameterParser(javax.servlet.ServletRequest request)
Method Detail |
public void init(java.lang.Object obj)
init
in interface ViewTool
obj
- the current ViewContext or ServletRequest
java.lang.IllegalArgumentException
- if the param is not a
ViewContext or ServletRequestprotected void setRequest(javax.servlet.ServletRequest request)
ServletRequest
protected javax.servlet.ServletRequest getRequest()
ServletRequest
for this instance.
ServletRequest
java.lang.UnsupportedOperationException
- if the request is nullpublic boolean exists(java.lang.String key)
key
- the parameter's key
true
if a parameter exists for the specified
key; otherwise, returns false
.public java.lang.String get(java.lang.String key)
key
- the parameter's key
null
if there is no matching
parameterpublic java.lang.String getString(java.lang.String key)
key
- the parameter's key
null
if there is no matching
parameterpublic java.lang.String getString(java.lang.String key, java.lang.String alternate)
public java.lang.Boolean getBoolean(java.lang.String key)
Boolean
object for the specified key or
null
if no matching parameter is foundpublic boolean getBoolean(java.lang.String key, boolean alternate)
public java.lang.Boolean getBoolean(java.lang.String key, java.lang.Boolean alternate)
Boolean
for the specified key or the specified
alternate if no matching parameter is foundpublic java.lang.Number getNumber(java.lang.String key)
Number
for the specified key or
null
if no matching parameter is foundpublic java.lang.Number getNumber(java.lang.String key, java.lang.Number alternate)
public int getInt(java.lang.String key, int alternate)
public double getDouble(java.lang.String key, double alternate)
public java.lang.String[] getStrings(java.lang.String key)
null
if the parameter does not existpublic java.lang.Number[] getNumbers(java.lang.String key)
null
if the parameter does not exist or the
parameter does not contain Numbers.public int[] getInts(java.lang.String key)
null
if the parameter does not exist or the
parameter does not contain ints.public double[] getDoubles(java.lang.String key)
null
if the parameter does not exist or the
parameter does not contain doubles.protected java.lang.Number parseNumber(java.lang.String value) throws java.lang.NumberFormatException
Number
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.)
value
- the string to be parsed
Number
java.lang.NumberFormatException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |