Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.codehaus.groovy.grails.web.servlet.mvc
[Groovy] Class GrailsParameterMap

java.lang.Object
  org.codehaus.groovy.grails.web.util.TypeConvertingMap
      org.codehaus.groovy.grails.web.servlet.mvc.GrailsParameterMap

class GrailsParameterMap
extends TypeConvertingMap

A parameter map class that allows mixing of request parameters and controller parameters. If a controller parameter is set with the same name as a request parameter the controller parameter value is retrieved.

Authors:
Graeme Rocher
Kate Rhodes
Since:
Oct 24, 2005

Field Summary
static java.lang.String REQUEST_BODY_PARSED

 
Fields inherited from class TypeConvertingMap
wrappedMap
 
Constructor Summary
GrailsParameterMap(java.util.Map values, javax.servlet.http.HttpServletRequest request)

Does not populate the GrailsParameterMap from the request but instead uses the supplied values.
GrailsParameterMap(javax.servlet.http.HttpServletRequest request)

Creates a GrailsParameterMap populating from the given request object
 
Method Summary
java.lang.Boolean boolean(java.lang.String name)

Helper method for obtaining float value from parameter
java.lang.Boolean boolean(java.lang.String name, java.lang.Boolean defaultValue)

Helper method for obtaining float value from parameter
java.lang.Byte byte(java.lang.String name)

Helper method for obtaining integer value from parameter
java.lang.Byte byte(java.lang.String name, java.lang.Integer defaultValue)

Helper method for obtaining integer value from parameter
java.lang.Character char(java.lang.String name)

Helper method for obtaining integer value from parameter
java.lang.Character char(java.lang.String name, java.lang.Character defaultValue)

Helper method for obtaining integer value from parameter
java.lang.Character char(java.lang.String name, java.lang.Integer defaultValue)

Helper method for obtaining integer value from parameter
void clear()

java.lang.Object clone()

boolean containsKey(java.lang.Object key)

boolean containsValue(java.lang.Object value)

java.lang.Double double(java.lang.String name)

Helper method for obtaining double value from parameter
java.lang.Double double(java.lang.String name, java.lang.Double defaultValue)

Helper method for obtaining double value from parameter
java.util.Set entrySet()

java.lang.Float float(java.lang.String name)

Helper method for obtaining float value from parameter
java.lang.Float float(java.lang.String name, java.lang.Float defaultValue)

Helper method for obtaining float value from parameter
java.lang.Object get(java.lang.Object key)

javax.servlet.http.HttpServletRequest getRequest()

@return Returns the request.
java.lang.Integer int(java.lang.String name)

Helper method for obtaining integer value from parameter
java.lang.Integer int(java.lang.String name, java.lang.Integer defaultValue)

Helper method for obtaining integer value from parameter
boolean isEmpty()

java.util.Set keySet()

java.util.List list(java.lang.String name)

Obtains a list of values from parameter.
java.lang.Long long(java.lang.String name)

Helper method for obtaining long value from parameter
java.lang.Long long(java.lang.String name, java.lang.Long defaultValue)

Helper method for obtaining long value from parameter
java.lang.Object put(java.lang.Object key, java.lang.Object value)

void putAll(java.util.Map map)

java.lang.Object remove(java.lang.Object key)

java.lang.Short short(java.lang.String name)

Helper method for obtaining short value from parameter
java.lang.Short short(java.lang.String name, java.lang.Integer defaultValue)

Helper method for obtaining short value from parameter
int size()

java.lang.String toQueryString()

Converts this parameter map into a query String.

java.lang.String toString()

java.lang.Object updateNestedKeys(java.util.Map keys)

java.util.Collection values()

 
Methods inherited from class TypeConvertingMap
clear, containsKey, containsValue, entrySet, equals, get, getBoolean, getByte, getChar, getDouble, getFloat, getInt, getList, getLong, getShort, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Field Detail

REQUEST_BODY_PARSED

public static final java.lang.String REQUEST_BODY_PARSED

 
Constructor Detail

GrailsParameterMap

GrailsParameterMap(java.util.Map values, javax.servlet.http.HttpServletRequest request)
Does not populate the GrailsParameterMap from the request but instead uses the supplied values.
Parameters:
values - The values to populate with
request - The request object

GrailsParameterMap

GrailsParameterMap(javax.servlet.http.HttpServletRequest request)
Creates a GrailsParameterMap populating from the given request object
Parameters:
request - The request object

 
Method Detail

boolean

java.lang.Boolean boolean(java.lang.String name)
Helper method for obtaining float value from parameter
Parameters:
name - The name of the parameter
Returns:
The double value or null if there isn't one

boolean

java.lang.Boolean boolean(java.lang.String name, java.lang.Boolean defaultValue)
Helper method for obtaining float value from parameter
Parameters:
name - The name of the parameter
Returns:
The double value or null if there isn't one

byte

java.lang.Byte byte(java.lang.String name)
Helper method for obtaining integer value from parameter
Parameters:
name - The name of the parameter
Returns:
The integer value or null if there isn't one

byte

java.lang.Byte byte(java.lang.String name, java.lang.Integer defaultValue)
Helper method for obtaining integer value from parameter
Parameters:
name - The name of the parameter
defaultValue - The default value to use if the parameter does not exist or cannot be converted to a Byte
Returns:
The integer value or null if there isn't one

char

java.lang.Character char(java.lang.String name)
Helper method for obtaining integer value from parameter
Parameters:
name - The name of the parameter
Returns:
The integer value or null if there isn't one

char

java.lang.Character char(java.lang.String name, java.lang.Character defaultValue)
Helper method for obtaining integer value from parameter
Parameters:
name - The name of the parameter
Returns:
The integer value or null if there isn't one

char

java.lang.Character char(java.lang.String name, java.lang.Integer defaultValue)
Helper method for obtaining integer value from parameter
Parameters:
name - The name of the parameter
Returns:
The integer value or null if there isn't one

clear

void clear()

clone

java.lang.Object clone()

containsKey

boolean containsKey(java.lang.Object key)

containsValue

boolean containsValue(java.lang.Object value)

double

java.lang.Double double(java.lang.String name)
Helper method for obtaining double value from parameter
Parameters:
name - The name of the parameter
Returns:
The double value or null if there isn't one

double

java.lang.Double double(java.lang.String name, java.lang.Double defaultValue)
Helper method for obtaining double value from parameter
Parameters:
name - The name of the parameter
defaultValue - The default value to use if the parameter does not exist or cannot be converted to a Double
Returns:
The double value or null if there isn't one

entrySet

java.util.Set entrySet()

float

java.lang.Float float(java.lang.String name)
Helper method for obtaining float value from parameter
Parameters:
name - The name of the parameter
Returns:
The double value or null if there isn't one

float

java.lang.Float float(java.lang.String name, java.lang.Float defaultValue)
Helper method for obtaining float value from parameter
Parameters:
name - The name of the parameter
defaultValue - The default value to use if the parameter does not exist or cannot be converted to a Float
Returns:
The double value or null if there isn't one

get

java.lang.Object get(java.lang.Object key)

getRequest

javax.servlet.http.HttpServletRequest getRequest()
Returns:
Returns the request.

int

java.lang.Integer int(java.lang.String name)
Helper method for obtaining integer value from parameter
Parameters:
name - The name of the parameter
Returns:
The integer value or null if there isn't one

int

java.lang.Integer int(java.lang.String name, java.lang.Integer defaultValue)
Helper method for obtaining integer value from parameter
Parameters:
name - The name of the parameter
defaultValue - The default value to use if the parameter does not exist or cannot be converted to an Integer
Returns:
The integer value or null if there isn't one

isEmpty

boolean isEmpty()

keySet

java.util.Set keySet()

list

java.util.List list(java.lang.String name)
Obtains a list of values from parameter.
Parameters:
name - The name of the parameter
Returns:
A list of values

long

java.lang.Long long(java.lang.String name)
Helper method for obtaining long value from parameter
Parameters:
name - The name of the parameter
Returns:
The long value or null if there isn't one

long

java.lang.Long long(java.lang.String name, java.lang.Long defaultValue)
Helper method for obtaining long value from parameter
Parameters:
name - The name of the parameter
defaultValue - The default value to use if the parameter does not exist or cannot be converted to a Long
Returns:
The long value or null if there isn't one

put

java.lang.Object put(java.lang.Object key, java.lang.Object value)

putAll

void putAll(java.util.Map map)

remove

java.lang.Object remove(java.lang.Object key)

short

java.lang.Short short(java.lang.String name)
Helper method for obtaining short value from parameter
Parameters:
name - The name of the parameter
Returns:
The short value or null if there isn't one

short

java.lang.Short short(java.lang.String name, java.lang.Integer defaultValue)
Helper method for obtaining short value from parameter
Parameters:
name - The name of the parameter
defaultValue - The default value to use if the parameter does not exist or cannot be converted to a Short
Returns:
The short value or null if there isn't one

size

int size()

toQueryString

java.lang.String toQueryString()
Converts this parameter map into a query String. Note that this will flatten nested keys separating them with the . character and URL encode the result
Returns:
A query String starting with the ? character

toString

java.lang.String toString()

updateNestedKeys

java.lang.Object updateNestedKeys(java.util.Map keys)

values

java.util.Collection values()

 

Groovy Documentation