|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.web.bind.ServletRequestUtils
public abstract class ServletRequestUtils
Parameter extraction methods, for an approach distinct from data binding, in which parameters of specific types are required.
This approach is very useful for simple submissions, where binding request parameters to a command object would be overkill.
Constructor Summary | |
---|---|
ServletRequestUtils()
|
Method Summary | |
---|---|
static Boolean |
getBooleanParameter(ServletRequest request,
String name)
Get a Boolean parameter, or null if not present. |
static boolean |
getBooleanParameter(ServletRequest request,
String name,
boolean defaultVal)
Get a boolean parameter, with a fallback value. |
static boolean[] |
getBooleanParameters(ServletRequest request,
String name)
Get an array of boolean parameters, return an empty array if not found. |
static Double |
getDoubleParameter(ServletRequest request,
String name)
Get a Double parameter, or null if not present. |
static double |
getDoubleParameter(ServletRequest request,
String name,
double defaultVal)
Get a double parameter, with a fallback value. |
static double[] |
getDoubleParameters(ServletRequest request,
String name)
Get an array of double parameters, return an empty array if not found. |
static Float |
getFloatParameter(ServletRequest request,
String name)
Get a Float parameter, or null if not present. |
static float |
getFloatParameter(ServletRequest request,
String name,
float defaultVal)
Get a float parameter, with a fallback value. |
static float[] |
getFloatParameters(ServletRequest request,
String name)
Get an array of float parameters, return an empty array if not found. |
static Integer |
getIntParameter(ServletRequest request,
String name)
Get an Integer parameter, or null if not present. |
static int |
getIntParameter(ServletRequest request,
String name,
int defaultVal)
Get an int parameter, with a fallback value. |
static int[] |
getIntParameters(ServletRequest request,
String name)
Get an array of int parameters, return an empty array if not found. |
static Long |
getLongParameter(ServletRequest request,
String name)
Get a Long parameter, or null if not present. |
static long |
getLongParameter(ServletRequest request,
String name,
long defaultVal)
Get a long parameter, with a fallback value. |
static long[] |
getLongParameters(ServletRequest request,
String name)
Get an array of long parameters, return an empty array if not found. |
static boolean |
getRequiredBooleanParameter(ServletRequest request,
String name)
Get a boolean parameter, throwing an exception if it isn't found or isn't a boolean. |
static boolean[] |
getRequiredBooleanParameters(ServletRequest request,
String name)
Get an array of boolean parameters, throwing an exception if not found or one isn't a boolean. |
static double |
getRequiredDoubleParameter(ServletRequest request,
String name)
Get a double parameter, throwing an exception if it isn't found or isn't a number. |
static double[] |
getRequiredDoubleParameters(ServletRequest request,
String name)
Get an array of double parameters, throwing an exception if not found or one is not a number. |
static float |
getRequiredFloatParameter(ServletRequest request,
String name)
Get a float parameter, throwing an exception if it isn't found or isn't a number. |
static float[] |
getRequiredFloatParameters(ServletRequest request,
String name)
Get an array of float parameters, throwing an exception if not found or one is not a number. |
static int |
getRequiredIntParameter(ServletRequest request,
String name)
Get an int parameter, throwing an exception if it isn't found or isn't a number. |
static int[] |
getRequiredIntParameters(ServletRequest request,
String name)
Get an array of int parameters, throwing an exception if not found or one is not a number.. |
static long |
getRequiredLongParameter(ServletRequest request,
String name)
Get a long parameter, throwing an exception if it isn't found or isn't a number. |
static long[] |
getRequiredLongParameters(ServletRequest request,
String name)
Get an array of long parameters, throwing an exception if not found or one is not a number. |
static String |
getRequiredStringParameter(ServletRequest request,
String name)
Get a String parameter, throwing an exception if it isn't found. |
static String[] |
getRequiredStringParameters(ServletRequest request,
String name)
Get an array of String parameters, throwing an exception if not found. |
static String |
getStringParameter(ServletRequest request,
String name)
Get a String parameter, or null if not present. |
static String |
getStringParameter(ServletRequest request,
String name,
String defaultVal)
Get a String parameter, with a fallback value. |
static String[] |
getStringParameters(ServletRequest request,
String name)
Get an array of String parameters, return an empty array if not found. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ServletRequestUtils()
Method Detail |
---|
public static Integer getIntParameter(ServletRequest request, String name) throws ServletRequestBindingException
null
if not present.
Throws an exception if it the parameter value isn't a number.
request
- current HTTP requestname
- the name of the parameter
null
if not present
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static int getIntParameter(ServletRequest request, String name, int defaultVal)
request
- current HTTP requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static int[] getIntParameters(ServletRequest request, String name)
request
- current HTTP requestname
- the name of the parameter with multiple possible valuespublic static int getRequiredIntParameter(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static int[] getRequiredIntParameters(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter with multiple possible values
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static Long getLongParameter(ServletRequest request, String name) throws ServletRequestBindingException
null
if not present.
Throws an exception if it the parameter value isn't a number.
request
- current HTTP requestname
- the name of the parameter
null
if not present
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static long getLongParameter(ServletRequest request, String name, long defaultVal)
request
- current HTTP requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static long[] getLongParameters(ServletRequest request, String name)
request
- current HTTP requestname
- the name of the parameter with multiple possible valuespublic static long getRequiredLongParameter(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static long[] getRequiredLongParameters(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter with multiple possible values
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static Float getFloatParameter(ServletRequest request, String name) throws ServletRequestBindingException
null
if not present.
Throws an exception if it the parameter value isn't a number.
request
- current HTTP requestname
- the name of the parameter
null
if not present
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static float getFloatParameter(ServletRequest request, String name, float defaultVal)
request
- current HTTP requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static float[] getFloatParameters(ServletRequest request, String name)
request
- current HTTP requestname
- the name of the parameter with multiple possible valuespublic static float getRequiredFloatParameter(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static float[] getRequiredFloatParameters(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter with multiple possible values
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static Double getDoubleParameter(ServletRequest request, String name) throws ServletRequestBindingException
null
if not present.
Throws an exception if it the parameter value isn't a number.
request
- current HTTP requestname
- the name of the parameter
null
if not present
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static double getDoubleParameter(ServletRequest request, String name, double defaultVal)
request
- current HTTP requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static double[] getDoubleParameters(ServletRequest request, String name)
request
- current HTTP requestname
- the name of the parameter with multiple possible valuespublic static double getRequiredDoubleParameter(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static double[] getRequiredDoubleParameters(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter with multiple possible values
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static Boolean getBooleanParameter(ServletRequest request, String name) throws ServletRequestBindingException
null
if not present.
Throws an exception if it the parameter value isn't a boolean.
Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).
request
- current HTTP requestname
- the name of the parameter
null
if not present
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static boolean getBooleanParameter(ServletRequest request, String name, boolean defaultVal)
Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).
request
- current HTTP requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static boolean[] getBooleanParameters(ServletRequest request, String name)
Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).
request
- current HTTP requestname
- the name of the parameter with multiple possible valuespublic static boolean getRequiredBooleanParameter(ServletRequest request, String name) throws ServletRequestBindingException
Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).
request
- current HTTP requestname
- the name of the parameter
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static boolean[] getRequiredBooleanParameters(ServletRequest request, String name) throws ServletRequestBindingException
Accepts "true", "on", "yes" (any case) and "1" as values for true; treats every other non-empty value as false (i.e. parses leniently).
request
- current HTTP requestname
- the name of the parameter
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static String getStringParameter(ServletRequest request, String name) throws ServletRequestBindingException
null
if not present.
request
- current HTTP requestname
- the name of the parameter
null
if not present
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static String getStringParameter(ServletRequest request, String name, String defaultVal)
request
- current HTTP requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static String[] getStringParameters(ServletRequest request, String name)
request
- current HTTP requestname
- the name of the parameter with multiple possible valuespublic static String getRequiredStringParameter(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caughtpublic static String[] getRequiredStringParameters(ServletRequest request, String name) throws ServletRequestBindingException
request
- current HTTP requestname
- the name of the parameter
ServletRequestBindingException
- a subclass of ServletException,
so it doesn't need to be caught
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |