com.dotmarketing.util
Class Parameter

java.lang.Object
  com.dotmarketing.util.Parameter

public class Parameter
extends java.lang.Object

Author:

Jtesser

Constructor Summary

Parameter()

Method Summary

static boolean	getBool(java.lang.String parameter) Deprecated. Returns true if parameter is not null and false if parameter is null.
static boolean	getBooleanFromString(java.lang.String paramter)
static boolean	getBooleanFromString(java.lang.String parameter, boolean defaultValue)
static double	getDouble(java.lang.String parameter) Returns 0 if parameter cannot be parsed or parameter is parameter can be parsed.
static double	getDouble(java.lang.String parameter, double defaultValue) Returns defaultValue if parameter cannot be parsed or parameter is parameter can be parsed.
static float	getFloat(java.lang.String parameter) Returns 0 if parameter cannot be parsed or parameter is parameter can be parsed.
static float	getFloat(java.lang.String parameter, float defaultValue) Returns defaultValue if parameter cannot be parsed or parameter is parameter can be parsed.
static int	getInt(java.lang.String parameter) Returns an int value based on a String parameter.
static int	getInt(java.lang.String parameter, HttpServletRequest req)
static int	getInt(java.lang.String parameter, int defaultValue, HttpServletRequest req)
static long	getLong(java.lang.String parameter) Returns a long value based on a String parameter.
static long	getLong(java.lang.String parameter, long defaultValue) Returns a long value based on a String parameter and a fail-safe value.
static java.lang.String	getString(java.lang.String parameter) Returns empty String if parameter is null or parameter if parameter is not null.
static java.lang.String	getString(java.lang.String parameter, java.lang.String defaultValue)
static boolean	isNotNull(java.lang.String parameter)

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter()

Method Detail

getLong

public static long getLong(java.lang.String parameter)

Returns a long value based on a String parameter. If the value cannot be parsed, zero is returned.

Parameters:

parameter - String representation of a long value

Returns:

long value

getLong

public static long getLong(java.lang.String parameter,
                           long defaultValue)

Returns a long value based on a String parameter and a fail-safe value. If the value cannot be parsed, defaultValue is returned.

Parameters:

parameter - String representation of a long value

defaultValue - long value to return if parameter cannot be parsed

Returns:

long value

getBool

public static boolean getBool(java.lang.String parameter)

Deprecated. Returns true if parameter is not null and false if parameter is null.

Parameters:

parameter - String value to test.

Returns:

boolean value

isNotNull

public static boolean isNotNull(java.lang.String parameter)

Parameters:

parameter - String value to test.

Returns:

true if parameter is not null and false if parameter is null.

getBooleanFromString

public static boolean getBooleanFromString(java.lang.String paramter)

Parameters:

paramter - String value to extract.

Returns:

true if parameter == "true" else returns false

getBooleanFromString

public static boolean getBooleanFromString(java.lang.String parameter,
                                           boolean defaultValue)

Parameters:

parameter - String value to extract.

defaultValue - boolean fall-through value

Returns:

true if parameter is "true", false if parameter is "false", defaultValue otherwise

getInt

public static int getInt(java.lang.String parameter)

Returns an int value based on a String parameter. If the value cannot be parsed, zero is returned.

Parameters:

parameter - String representation of an int value

Returns:

int value

getInt

public static int getInt(java.lang.String parameter,
                         HttpServletRequest req)

getInt

public static int getInt(java.lang.String parameter,
                         int defaultValue,
                         HttpServletRequest req)

getString

public static java.lang.String getString(java.lang.String parameter)

Returns empty String if parameter is null or parameter if parameter is not null.

Parameters:

parameter - String parameter to test

Returns:

a non-null String

getString

public static java.lang.String getString(java.lang.String parameter,
                                         java.lang.String defaultValue)

Parameters:

parameter - String parameter to test

defaultValue - String to use if parameter is null

Returns:

defaultValue if parameter is null or parameter if parameter is not null

getFloat

public static float getFloat(java.lang.String parameter)

Returns 0 if parameter cannot be parsed or parameter is parameter can be parsed.

Parameters:

parameter - String parameter to test

Returns:

float value

getFloat

public static float getFloat(java.lang.String parameter,
                             float defaultValue)

Returns defaultValue if parameter cannot be parsed or parameter is parameter can be parsed.

Parameters:

parameter - String parameter to test

defaultValue - float value to return if parameter cannot be parsed

Returns:

float value

getDouble

public static double getDouble(java.lang.String parameter)

Returns 0 if parameter cannot be parsed or parameter is parameter can be parsed.

Parameters:

parameter - String parameter to test

Returns:

double value

getDouble

public static double getDouble(java.lang.String parameter,
                               double defaultValue)

Returns defaultValue if parameter cannot be parsed or parameter is parameter can be parsed.

Parameters:

parameter - String parameter to test

defaultValue - double value to return if parameter cannot be parsed

Returns:

double value