|
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.portlet.bind.PortletRequestUtils
public abstract class PortletRequestUtils
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 | |
---|---|
PortletRequestUtils()
|
Method Summary | |
---|---|
static Boolean |
getBooleanParameter(PortletRequest request,
String name)
Get a Boolean parameter, or null if not present. |
static boolean |
getBooleanParameter(PortletRequest request,
String name,
boolean defaultVal)
Get a boolean parameter, with a fallback value. |
static boolean[] |
getBooleanParameters(PortletRequest request,
String name)
Get an array of boolean parameters, return an empty array if not found. |
static Double |
getDoubleParameter(PortletRequest request,
String name)
Get a Double parameter, or null if not present. |
static double |
getDoubleParameter(PortletRequest request,
String name,
double defaultVal)
Get a double parameter, with a fallback value. |
static double[] |
getDoubleParameters(PortletRequest request,
String name)
Get an array of double parameters, return an empty array if not found. |
static Float |
getFloatParameter(PortletRequest request,
String name)
Get a Float parameter, or null if not present. |
static float |
getFloatParameter(PortletRequest request,
String name,
float defaultVal)
Get a float parameter, with a fallback value. |
static float[] |
getFloatParameters(PortletRequest request,
String name)
Get an array of float parameters, return an empty array if not found. |
static Integer |
getIntParameter(PortletRequest request,
String name)
Get an Integer parameter, or null if not present. |
static int |
getIntParameter(PortletRequest request,
String name,
int defaultVal)
Get an int parameter, with a fallback value. |
static int[] |
getIntParameters(PortletRequest request,
String name)
Get an array of int parameters, return an empty array if not found. |
static Long |
getLongParameter(PortletRequest request,
String name)
Get a Long parameter, or null if not present. |
static long |
getLongParameter(PortletRequest request,
String name,
long defaultVal)
Get a long parameter, with a fallback value. |
static long[] |
getLongParameters(PortletRequest request,
String name)
Get an array of long parameters, return an empty array if not found. |
static boolean |
getRequiredBooleanParameter(PortletRequest request,
String name)
Get a boolean parameter, throwing an exception if it isn't found or isn't a boolean. |
static boolean[] |
getRequiredBooleanParameters(PortletRequest request,
String name)
Get an array of boolean parameters, throwing an exception if not found or one isn't a boolean. |
static double |
getRequiredDoubleParameter(PortletRequest request,
String name)
Get a double parameter, throwing an exception if it isn't found or isn't a number. |
static double[] |
getRequiredDoubleParameters(PortletRequest request,
String name)
Get an array of double parameters, throwing an exception if not found or one is not a number. |
static float |
getRequiredFloatParameter(PortletRequest request,
String name)
Get a float parameter, throwing an exception if it isn't found or isn't a number. |
static float[] |
getRequiredFloatParameters(PortletRequest request,
String name)
Get an array of float parameters, throwing an exception if not found or one is not a number. |
static int |
getRequiredIntParameter(PortletRequest request,
String name)
Get an int parameter, throwing an exception if it isn't found or isn't a number. |
static int[] |
getRequiredIntParameters(PortletRequest request,
String name)
Get an array of int parameters, throwing an exception if not found or one is not a number.. |
static long |
getRequiredLongParameter(PortletRequest request,
String name)
Get a long parameter, throwing an exception if it isn't found or isn't a number. |
static long[] |
getRequiredLongParameters(PortletRequest request,
String name)
Get an array of long parameters, throwing an exception if not found or one is not a number. |
static String |
getRequiredStringParameter(PortletRequest request,
String name)
Get a String parameter, throwing an exception if it isn't found or is empty. |
static String[] |
getRequiredStringParameters(PortletRequest request,
String name)
Get an array of String parameters, throwing an exception if not found or one is empty. |
static String |
getStringParameter(PortletRequest request,
String name)
Get a String parameter, or null if not present. |
static String |
getStringParameter(PortletRequest request,
String name,
String defaultVal)
Get a String parameter, with a fallback value. |
static String[] |
getStringParameters(PortletRequest 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 PortletRequestUtils()
Method Detail |
---|
public static Integer getIntParameter(PortletRequest request, String name) throws PortletRequestBindingException
null
if not present.
Throws an exception if it the parameter value isn't a number.
request
- current portlet requestname
- the name of the parameter
null
if not present
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static int getIntParameter(PortletRequest request, String name, int defaultVal)
request
- current portlet requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static int[] getIntParameters(PortletRequest request, String name)
request
- current portlet requestname
- the name of the parameter with multiple possible valuespublic static int getRequiredIntParameter(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static int[] getRequiredIntParameters(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter with multiple possible values
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static Long getLongParameter(PortletRequest request, String name) throws PortletRequestBindingException
null
if not present.
Throws an exception if it the parameter value isn't a number.
request
- current portlet requestname
- the name of the parameter
null
if not present
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static long getLongParameter(PortletRequest request, String name, long defaultVal)
request
- current portlet requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static long[] getLongParameters(PortletRequest request, String name)
request
- current portlet requestname
- the name of the parameter with multiple possible valuespublic static long getRequiredLongParameter(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static long[] getRequiredLongParameters(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter with multiple possible values
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static Float getFloatParameter(PortletRequest request, String name) throws PortletRequestBindingException
null
if not present.
Throws an exception if it the parameter value isn't a number.
request
- current portlet requestname
- the name of the parameter
null
if not present
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static float getFloatParameter(PortletRequest request, String name, float defaultVal)
request
- current portlet requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static float[] getFloatParameters(PortletRequest request, String name)
request
- current portlet requestname
- the name of the parameter with multiple possible valuespublic static float getRequiredFloatParameter(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static float[] getRequiredFloatParameters(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter with multiple possible values
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static Double getDoubleParameter(PortletRequest request, String name) throws PortletRequestBindingException
null
if not present.
Throws an exception if it the parameter value isn't a number.
request
- current portlet requestname
- the name of the parameter
null
if not present
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static double getDoubleParameter(PortletRequest request, String name, double defaultVal)
request
- current portlet requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static double[] getDoubleParameters(PortletRequest request, String name)
request
- current portlet requestname
- the name of the parameter with multiple possible valuespublic static double getRequiredDoubleParameter(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static double[] getRequiredDoubleParameters(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter with multiple possible values
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static Boolean getBooleanParameter(PortletRequest request, String name) throws PortletRequestBindingException
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 portlet requestname
- the name of the parameter
null
if not present
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static boolean getBooleanParameter(PortletRequest 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 portlet requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static boolean[] getBooleanParameters(PortletRequest 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 portlet requestname
- the name of the parameter with multiple possible valuespublic static boolean getRequiredBooleanParameter(PortletRequest request, String name) throws PortletRequestBindingException
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 portlet requestname
- the name of the parameter
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static boolean[] getRequiredBooleanParameters(PortletRequest request, String name) throws PortletRequestBindingException
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 portlet requestname
- the name of the parameter
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static String getStringParameter(PortletRequest request, String name) throws PortletRequestBindingException
null
if not present.
Throws an exception if it the parameter value is empty.
request
- current portlet requestname
- the name of the parameter
null
if not present
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static String getStringParameter(PortletRequest request, String name, String defaultVal)
request
- current portlet requestname
- the name of the parameterdefaultVal
- the default value to use as fallbackpublic static String[] getStringParameters(PortletRequest request, String name)
request
- current portlet requestname
- the name of the parameter with multiple possible valuespublic static String getRequiredStringParameter(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter
PortletRequestBindingException
- a subclass of PortletException,
so it doesn't need to be caughtpublic static String[] getRequiredStringParameters(PortletRequest request, String name) throws PortletRequestBindingException
request
- current portlet requestname
- the name of the parameter
PortletRequestBindingException
- a subclass of PortletException,
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 |