PortletRequestUtils

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.web.portlet.bind
Class PortletRequestUtils

java.lang.Object
  org.springframework.web.portlet.bind.PortletRequestUtils

public abstract class PortletRequestUtils
extends Object
extends Object

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.

Since:: 2.0
Author:: Juergen Hoeller, Keith Donald, John A. Lewis

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

PortletRequestUtils

public PortletRequestUtils()

Method Detail

getIntParameter

public static Integer getIntParameter(PortletRequest request,
                                      String name)
                               throws PortletRequestBindingException

Get an Integer parameter, or null if not present. Throws an exception if it the parameter value isn't a number.

Parameters:: request - current portlet request; name - the name of the parameter
Returns:: the Integer value, or null if not present
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getIntParameter

public static int getIntParameter(PortletRequest request,
                                  String name,
                                  int defaultVal)

Get an int parameter, with a fallback value. Never throws an exception. Can pass a distinguished value as default to enable checks of whether it was supplied.

Parameters:: request - current portlet request; name - the name of the parameter; defaultVal - the default value to use as fallback

getIntParameters

public static int[] getIntParameters(PortletRequest request,
                                     String name)

Get an array of int parameters, return an empty array if not found.

Parameters:: request - current portlet request; name - the name of the parameter with multiple possible values

getRequiredIntParameter

public static int getRequiredIntParameter(PortletRequest request,
                                          String name)
                                   throws PortletRequestBindingException

Get an int parameter, throwing an exception if it isn't found or isn't a number.

Parameters:: request - current portlet request; name - the name of the parameter
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getRequiredIntParameters

public static int[] getRequiredIntParameters(PortletRequest request,
                                             String name)
                                      throws PortletRequestBindingException

Get an array of int parameters, throwing an exception if not found or one is not a number..

Parameters:: request - current portlet request; name - the name of the parameter with multiple possible values
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getLongParameter

public static Long getLongParameter(PortletRequest request,
                                    String name)
                             throws PortletRequestBindingException

Get a Long parameter, or null if not present. Throws an exception if it the parameter value isn't a number.

Parameters:: request - current portlet request; name - the name of the parameter
Returns:: the Long value, or null if not present
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getLongParameter

public static long getLongParameter(PortletRequest request,
                                    String name,
                                    long defaultVal)

Get a long parameter, with a fallback value. Never throws an exception. Can pass a distinguished value as default to enable checks of whether it was supplied.

Parameters:: request - current portlet request; name - the name of the parameter; defaultVal - the default value to use as fallback

getLongParameters

public static long[] getLongParameters(PortletRequest request,
                                       String name)

Get an array of long parameters, return an empty array if not found.

Parameters:: request - current portlet request; name - the name of the parameter with multiple possible values

getRequiredLongParameter

public static long getRequiredLongParameter(PortletRequest request,
                                            String name)
                                     throws PortletRequestBindingException

Get a long parameter, throwing an exception if it isn't found or isn't a number.

Parameters:: request - current portlet request; name - the name of the parameter
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getRequiredLongParameters

public static long[] getRequiredLongParameters(PortletRequest request,
                                               String name)
                                        throws PortletRequestBindingException

Get an array of long parameters, throwing an exception if not found or one is not a number.

Parameters:: request - current portlet request; name - the name of the parameter with multiple possible values
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getFloatParameter

public static Float getFloatParameter(PortletRequest request,
                                      String name)
                               throws PortletRequestBindingException

Get a Float parameter, or null if not present. Throws an exception if it the parameter value isn't a number.

Parameters:: request - current portlet request; name - the name of the parameter
Returns:: the Float value, or null if not present
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getFloatParameter

public static float getFloatParameter(PortletRequest request,
                                      String name,
                                      float defaultVal)

Get a float parameter, with a fallback value. Never throws an exception. Can pass a distinguished value as default to enable checks of whether it was supplied.

Parameters:: request - current portlet request; name - the name of the parameter; defaultVal - the default value to use as fallback

getFloatParameters

public static float[] getFloatParameters(PortletRequest request,
                                         String name)

Get an array of float parameters, return an empty array if not found.

Parameters:: request - current portlet request; name - the name of the parameter with multiple possible values

getRequiredFloatParameter

public static float getRequiredFloatParameter(PortletRequest request,
                                              String name)
                                       throws PortletRequestBindingException

Get a float parameter, throwing an exception if it isn't found or isn't a number.

Parameters:: request - current portlet request; name - the name of the parameter
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getRequiredFloatParameters

public static float[] getRequiredFloatParameters(PortletRequest request,
                                                 String name)
                                          throws PortletRequestBindingException

Get an array of float parameters, throwing an exception if not found or one is not a number.

Parameters:: request - current portlet request; name - the name of the parameter with multiple possible values
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getDoubleParameter

public static Double getDoubleParameter(PortletRequest request,
                                        String name)
                                 throws PortletRequestBindingException

Get a Double parameter, or null if not present. Throws an exception if it the parameter value isn't a number.

Parameters:: request - current portlet request; name - the name of the parameter
Returns:: the Double value, or null if not present
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getDoubleParameter

public static double getDoubleParameter(PortletRequest request,
                                        String name,
                                        double defaultVal)

Get a double parameter, with a fallback value. Never throws an exception. Can pass a distinguished value as default to enable checks of whether it was supplied.

Parameters:: request - current portlet request; name - the name of the parameter; defaultVal - the default value to use as fallback

getDoubleParameters

public static double[] getDoubleParameters(PortletRequest request,
                                           String name)

Get an array of double parameters, return an empty array if not found.

Parameters:: request - current portlet request; name - the name of the parameter with multiple possible values

getRequiredDoubleParameter

public static double getRequiredDoubleParameter(PortletRequest request,
                                                String name)
                                         throws PortletRequestBindingException

Get a double parameter, throwing an exception if it isn't found or isn't a number.

Parameters:: request - current portlet request; name - the name of the parameter
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getRequiredDoubleParameters

public static double[] getRequiredDoubleParameters(PortletRequest request,
                                                   String name)
                                            throws PortletRequestBindingException

Get an array of double parameters, throwing an exception if not found or one is not a number.

Parameters:: request - current portlet request; name - the name of the parameter with multiple possible values
Throws:: PortletRequestBindingException - a subclass of PortletException, so it doesn't need to be caught

getBooleanParameter

public static Boolean getBooleanParameter(PortletRequest request,
                                          String name)
                                   throws PortletRequestBindingException

Get a Boolean parameter, or null if not present. Throws an exception if it the parameter value isn't a boolean.