RequestParam (Sling Commons 0.1.0 API)

java.lang.Object
- io.wcm.sling.commons.request.RequestParam

```
public final class RequestParam
extends Object
```
Several helper methods for getting parameters from the servlet request. This class automatically converts string parameters from ISO-8859-1 to UTF-8, because UTF-8 form data is expected by default. This is only done if no request parameter "_charset_" with an explicit encoding is set. If it is set, the SlingHttpServletRequest automatically converts the parameter data.

Field Summary

Fields
Modifier and Type Field and Description

static String PARAMETER_FORMENCODING
The name of the form encoding parameter.

Fields
Modifier and Type	Field and Description
`static String`	`PARAMETER_FORMENCODING` The name of the form encoding parameter.

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`get(Map<String,String[]> requestMap, String param)` Returns a request parameter.
`static String`	`get(javax.servlet.ServletRequest request, String param)` Returns a request parameter.
`static String`	`get(javax.servlet.ServletRequest request, String param, String defaultValue)` Returns a request parameter.
`static boolean`	`getBoolean(javax.servlet.ServletRequest request, String param)` Returns a request parameter as boolean.
`static boolean`	`getBoolean(javax.servlet.ServletRequest request, String param, boolean defaultValue)` Returns a request parameter as boolean.
`static double`	`getDouble(javax.servlet.ServletRequest request, String param)` Returns a request parameter as double.
`static double`	`getDouble(javax.servlet.ServletRequest request, String param, double defaultValue)` Returns a request parameter as double.
`static <T extends Enum> T`	`getEnum(javax.servlet.ServletRequest request, String param, Class<T> enumClass)` Returns a request parameter as enum value.
`static <T extends Enum> T`	`getEnum(javax.servlet.ServletRequest request, String param, Class<T> enumClass, T defaultValue)` Returns a request parameter as enum value.
`static float`	`getFloat(javax.servlet.ServletRequest request, String param)` Returns a request parameter as float.
`static float`	`getFloat(javax.servlet.ServletRequest request, String param, float defaultValue)` Returns a request parameter as float.
`static int`	`getInt(javax.servlet.ServletRequest request, String param)` Returns a request parameter as integer.
`static int`	`getInt(javax.servlet.ServletRequest request, String param, int defaultValue)` Returns a request parameter as integer.
`static long`	`getLong(javax.servlet.ServletRequest request, String param)` Returns a request parameter as long.
`static long`	`getLong(javax.servlet.ServletRequest request, String param, long defaultValue)` Returns a request parameter as long.
`static String[]`	`getMultiple(javax.servlet.ServletRequest request, String param)` Returns a request parameter array.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAMETER_FORMENCODING
```
public static final String PARAMETER_FORMENCODING
```
    The name of the form encoding parameter. If such a form parameter is set in a request the SlingHttpServletRequest automatically transcodes all parameters to this encoding.
    
    See Also:
    Constant Field Values
- Method Detail
  - get
```
public static String get(javax.servlet.ServletRequest request,
         String param)
```
    Returns a request parameter.
    In addition the method fixes problems with incorrect UTF-8 characters returned by the servlet engine. All character data is converted from ISO-8859-1 to UTF-8 if not '_charset_' parameter is provided.
    
    Parameters:
    request - Request.
    param - Parameter name.
    
    Returns:
    Parameter value or null if it is not set.
  - get
```
public static String get(javax.servlet.ServletRequest request,
         String param,
         String defaultValue)
```
    Returns a request parameter.
    In addition the method fixes problems with incorrect UTF-8 characters returned by the servlet engine. All character data is converted from ISO-8859-1 to UTF-8 if not '_charset_' parameter is provided.
    
    Parameters:
    request - Request.
    param - Parameter name.
    defaultValue - Default value.
    
    Returns:
    Parameter value or the default value if it is not set.
  - getMultiple
```
public static String[] getMultiple(javax.servlet.ServletRequest request,
                   String param)
```
    Returns a request parameter array.
    The method fixes problems with incorrect UTF-8 characters returned by the servlet engine. All character data is converted from ISO-8859-1 to UTF-8.
    
    Parameters:
    request - Request.
    param - Parameter name.
    
    Returns:
    Parameter value array value or null if it is not set.
  - get
```
public static String get(Map<String,String[]> requestMap,
         String param)
```
    Returns a request parameter.
    In addition the method fixes problems with incorrect UTF-8 characters returned by the servlet engine. All character data is converted from ISO-8859-1 to UTF-8.
    
    Parameters:
    requestMap - Request Parameter map.
    param - Parameter name.
    
    Returns:
    Parameter value or null if it is not set.
  - getInt
```
public static int getInt(javax.servlet.ServletRequest request,
         String param)
```
    Returns a request parameter as integer.
    
    Parameters:
    request - Request.
    param - Parameter name.
    
    Returns:
    Parameter value or 0 if it does not exist or is not a number.
  - getInt
```
public static int getInt(javax.servlet.ServletRequest request,
         String param,
         int defaultValue)
```
    Returns a request parameter as integer.
    
    Parameters:
    request - Request.
    param - Parameter name.
    defaultValue - Default value.
    
    Returns:
    Parameter value or default value if it does not exist or is not a number.
  - getLong
```
public static long getLong(javax.servlet.ServletRequest request,
           String param)
```
    Returns a request parameter as long.
    
    Parameters:
    request - Request.
    param - Parameter name.
    
    Returns:
    Parameter value or 0 if it does not exist or is not a number.
  - getLong
```
public static long getLong(javax.servlet.ServletRequest request,
           String param,
           long defaultValue)
```
    Returns a request parameter as long.
    
    Parameters:
    request - Request.
    param - Parameter name.
    defaultValue - Default value.
    
    Returns:
    Parameter value or default value if it does not exist or is not a number.
  - getFloat
```
public static float getFloat(javax.servlet.ServletRequest request,
             String param)
```
    Returns a request parameter as float.
    
    Parameters:
    request - Request.
    param - Parameter name.
    
    Returns:
    Parameter value or 0 if it does not exist or is not a number.
  - getFloat
```
public static float getFloat(javax.servlet.ServletRequest request,
             String param,
             float defaultValue)
```
    Returns a request parameter as float.
    
    Parameters:
    request - Request.
    param - Parameter name.
    defaultValue - Default value.
    
    Returns:
    Parameter value or default value if it does not exist or is not a number.
  - getDouble
```
public static double getDouble(javax.servlet.ServletRequest request,
               String param)
```
    Returns a request parameter as double.
    
    Parameters:
    request - Request.
    param - Parameter name.
    
    Returns:
    Parameter value or 0 if it does not exist or is not a number.
  - getDouble
```
public static double getDouble(javax.servlet.ServletRequest request,
               String param,
               double defaultValue)
```
    Returns a request parameter as double.
    
    Parameters:
    request - Request.
    param - Parameter name.
    defaultValue - Default value.
    
    Returns:
    Parameter value or default value if it does not exist or is not a number.
  - getBoolean
```
public static boolean getBoolean(javax.servlet.ServletRequest request,
                 String param)
```
    Returns a request parameter as boolean.
    
    Parameters:
    request - Request.
    param - Parameter name.
    
    Returns:
    Parameter value or false if it does not exist or cannot be interpreted as boolean.
  - getBoolean
```
public static boolean getBoolean(javax.servlet.ServletRequest request,
                 String param,
                 boolean defaultValue)
```
    Returns a request parameter as boolean.
    
    Parameters:
    request - Request.
    param - Parameter name.
    defaultValue - Default value.
    
    Returns:
    Parameter value or default value if it does not exist or false if it cannot be interpreted as boolean.
  - getEnum
```
public static <T extends Enum> T getEnum(javax.servlet.ServletRequest request,
                         String param,
                         Class<T> enumClass)
```
    Returns a request parameter as enum value.
    
    Type Parameters:
    T - Enum type
    Parameters:
    request - Request.
    param - Parameter name.
    enumClass - Enum class
    
    Returns:
    Parameter value or null if it is not set or an invalid enum value.
  - getEnum
```
public static <T extends Enum> T getEnum(javax.servlet.ServletRequest request,
                         String param,
                         Class<T> enumClass,
                         T defaultValue)
```
    Returns a request parameter as enum value.
    
    Type Parameters:
    T - Enum type
    Parameters:
    request - Request.
    param - Parameter name.
    enumClass - Enum class
    defaultValue - Default value.
    
    Returns:
    Parameter value or the default value if it is not set or an invalid enum value.

Class RequestParam

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARAMETER_FORMENCODING

Method Detail

get

get

getMultiple

get

getInt

getInt

getLong

getLong

getFloat

getFloat

getDouble

getDouble

getBoolean

getBoolean

getEnum

getEnum