com.communote.common.util

Class ParameterHelper

java.lang.Object

com.communote.common.util.ParameterHelper

public final class ParameterHelper
extends Object

Helper class to retrieve parameters in a given format. The parameter map can be values being either String or String[] (in case of ServletRequest#getParameterMap()).

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static Boolean	getParameterAsBoolean(Map<String,? extends Object> parameters, String parameter) Gets the parameter as boolean.
static boolean	getParameterAsBoolean(Map<String,? extends Object> parameters, String parameter, boolean fallback) Gets the parameter as boolean.
static Date	getParameterAsDate(Map<String,? extends Object> parameters, String parameter) Gets the parameter as date.
static Double	getParameterAsDouble(Map<String,? extends Object> parameters, String parameter) Gets the parameter as double.
static Integer	getParameterAsInteger(Map<String,? extends Object> parameters, String parameter) Gets the parameter as integer.
static int	getParameterAsInteger(Map<String,? extends Object> parameters, String parameter, int fallback) Gets the parameter as integer.
static Long	getParameterAsLong(Map<String,? extends Object> parameters, String parameter) Gets the parameter as long.
static Long	getParameterAsLong(Map<String,? extends Object> parameters, String parameter, Long fallback) Gets the parameter as long.
static Long[]	getParameterAsLongArray(Map<String,? extends Object> parameters, String parameter) Gets the parameter as long array.
static Long[]	getParameterAsLongArray(Map<String,? extends Object> parameters, String parameterName, Long[] fallback) Gets the parameter as long array.
static List<Long>	getParameterAsLongList(Map<String,? extends Object> parameters, String parameter) Gets the parameter as list.
static String	getParameterAsString(Map<String,? extends Object> parameters, String parameterName)
static String	getParameterAsString(Map<String,? extends Object> parameters, String parameterName, String fallback)
static String[]	getParameterAsStringArray(Map<String,? extends Object> parameters, String parameterName, String separator)
static Set<String>	getParameterAsStringSet(Map<String,? extends Object> parameters, String parameterName, String separator) Get the value of the parameter and split it by the separator.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getParameterAsBoolean

public static Boolean getParameterAsBoolean(Map<String,? extends Object> parameters,
                                            String parameter)

Gets the parameter as boolean.

Parameters:

parameters - the parameters

parameter - the parameter

Returns:

the parameter as boolean

getParameterAsBoolean

public static boolean getParameterAsBoolean(Map<String,? extends Object> parameters,
                                            String parameter,
                                            boolean fallback)

Gets the parameter as boolean.

Parameters:

parameters - the parameters

parameter - the parameter

fallback - the fallback

Returns:

the parameter as boolean

getParameterAsDate

public static Date getParameterAsDate(Map<String,? extends Object> parameters,
                                      String parameter)

Gets the parameter as date. The parameters value must be in Milliseconds!

Parameters:

parameters - the parameters

parameter - the parameter for the timestamp

Returns:

the parameter as date or null if the parameter is not set

getParameterAsDouble

public static Double getParameterAsDouble(Map<String,? extends Object> parameters,
                                          String parameter)

Gets the parameter as double.

Parameters:

parameters - the parameters

parameter - the parameter

Returns:

the parameter as double, null if not set or on invalid input

getParameterAsInteger

public static Integer getParameterAsInteger(Map<String,? extends Object> parameters,
                                            String parameter)

Gets the parameter as integer.

Parameters:

parameters - the parameters

parameter - the parameter

Returns:

the parameter as integer

getParameterAsInteger

public static int getParameterAsInteger(Map<String,? extends Object> parameters,
                                        String parameter,
                                        int fallback)

Gets the parameter as integer.

Parameters:

parameters - the parameters

parameter - the parameter

fallback - the fallback

Returns:

the parameter as integer

getParameterAsLong

public static Long getParameterAsLong(Map<String,? extends Object> parameters,
                                      String parameter)

Gets the parameter as long.

Parameters:

parameters - the parameters

parameter - the parameter

Returns:

the parameter as long

getParameterAsLong

public static Long getParameterAsLong(Map<String,? extends Object> parameters,
                                      String parameter,
                                      Long fallback)

Gets the parameter as long.

Parameters:

parameters - the parameters

parameter - the parameter

fallback - the fallback

Returns:

the parameter as long

getParameterAsLongArray

public static Long[] getParameterAsLongArray(Map<String,? extends Object> parameters,
                                             String parameter)

Gets the parameter as long array.

Parameters:

parameters - the parameters

parameter - the parameter name

Returns:

the parameter as long array

getParameterAsLongArray

public static Long[] getParameterAsLongArray(Map<String,? extends Object> parameters,
                                             String parameterName,
                                             Long[] fallback)

Gets the parameter as long array.

Parameters:

parameters - the parameter map with the values being either String or String[] (in case of ServletRequest#getParameterMap(). The values can be a single number or a number array, but the numbers must not be floats or doubles.

parameterName - the parameter name

fallback - the fallback

Returns:

getParameterAsLongList

public static List<Long> getParameterAsLongList(Map<String,? extends Object> parameters,
                                                String parameter)

Gets the parameter as list.

Parameters:

parameters - the parameters

parameter - the parameter name

Returns:

the parameter as list of Long objects

getParameterAsString

public static String getParameterAsString(Map<String,? extends Object> parameters,
                                          String parameterName)

Parameters:

parameters - the parameter map with the values being either String or String[] (in case of ServletRequest#getParameterMap()

parameterName - the name of the parameter

Returns:

the parameter as string

getParameterAsString

public static String getParameterAsString(Map<String,? extends Object> parameters,
                                          String parameterName,
                                          String fallback)

Parameters:

parameters - the parameter map with the values being either String or String[] (in case of ServletRequest#getParameterMap()

parameterName - the name of the parameter

fallback - the fallback

Returns:

the parameter as string or the fallback if the parameter is null

getParameterAsStringArray

public static String[] getParameterAsStringArray(Map<String,? extends Object> parameters,
                                                 String parameterName,
                                                 String separator)

Parameters:

parameters - the parameter map with the values being either String or String[] (in case of ServletRequest#getParameterMap()

parameterName - the name of the parameter

separator - the separator by which the value will be splitted

Returns:

the parameter value splitted by the separator as strings

getParameterAsStringSet

public static Set<String> getParameterAsStringSet(Map<String,? extends Object> parameters,
                                                  String parameterName,
                                                  String separator)

Get the value of the parameter and split it by the separator. Return the values as set. If the parameter value is empty or not existing null is returned.

Parameters:

parameters - the parameter map with the values being either String or String[] (in case of ServletRequest#getParameterMap()

parameterName - the name of the parameter

separator - the separator by which the value will be splitted

Returns:

the parameter value splitted by the separator as a Set of Strings (or null)