Package grails.web.servlet.mvc

Class GrailsParameterMap

  • All Implemented Interfaces:
    groovy.lang.GroovyObject, java.lang.Cloneable, java.util.Map
    public class GrailsParameterMap
extends grails.util.TypeConvertingMap
implements java.lang.Cloneable
    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.
    Since:
    Oct 24, 2005

    • Nested Class Summary

      • Nested classes/interfaces inherited from interface java.util.Map

        java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.Object[] EMPTY_ARGS  
      static java.lang.String REQUEST_BODY_PARSED  

      • Fields inherited from class grails.util.AbstractTypeConvertingMap

        wrappedMap

    • Constructor Summary

      Constructors 
      Constructor Description
      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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addParametersFrom​(GrailsParameterMap otherMap)  
      java.lang.Object clone()  
      java.lang.Object get​(java.lang.Object key)  
      java.util.Date getDate​(java.lang.String name)
      Obtains a date for the parameter name using the default format
      java.lang.Object getIdentifier()  
      javax.servlet.http.HttpServletRequest getRequest()  
      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.String toQueryString()
      Converts this parameter map into a query String.
      protected void updateNestedKeys​(java.util.Map keys)  

      • Methods inherited from class grails.util.TypeConvertingMap

        boolean, boolean, byte, byte, char, char, char, double, double, float, float, int, int, long, long, short, short

      • Methods inherited from class grails.util.AbstractTypeConvertingMap

        asBoolean, clear, containsKey, containsValue, date, date, date, entrySet, equals, equals, getBoolean, getBoolean, getByte, getByte, getChar, getChar, getDate, getDouble, getDouble, getFloat, getFloat, getInt, getInt, getList, getLong, getLong, getShort, getShort, hashCode, isEmpty, keySet, list, size, toString, values

      • Methods inherited from class groovy.lang.GroovyObjectSupport

        getMetaClass, setMetaClass

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface groovy.lang.GroovyObject

        getProperty, invokeMethod, setProperty

      • Methods inherited from interface java.util.Map

        compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

    • Field Detail

      • REQUEST_BODY_PARSED

        public static final java.lang.String REQUEST_BODY_PARSED
        See Also:
        Constant Field Values

      • EMPTY_ARGS

        public static final java.lang.Object[] EMPTY_ARGS

    • Constructor Detail

      • GrailsParameterMap

        public 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

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

    • Method Detail

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class grails.util.TypeConvertingMap

      • getRequest

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

      • get

        public java.lang.Object get​(java.lang.Object key)
        Specified by:
        get in interface java.util.Map
        Overrides:
        get in class grails.util.AbstractTypeConvertingMap

      • put

        public java.lang.Object put​(java.lang.Object key,
                            java.lang.Object value)
        Specified by:
        put in interface java.util.Map
        Overrides:
        put in class grails.util.AbstractTypeConvertingMap

      • remove

        public java.lang.Object remove​(java.lang.Object key)
        Specified by:
        remove in interface java.util.Map
        Overrides:
        remove in class grails.util.AbstractTypeConvertingMap

      • putAll

        public void putAll​(java.util.Map map)
        Specified by:
        putAll in interface java.util.Map
        Overrides:
        putAll in class grails.util.AbstractTypeConvertingMap

      • getDate

        public java.util.Date getDate​(java.lang.String name)
        Obtains a date for the parameter name using the default format
        Overrides:
        getDate in class grails.util.AbstractTypeConvertingMap
        Parameters:
        name - The name of the parameter
        Returns:
        A date or null

      • toQueryString

        public 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

      • getIdentifier

        public java.lang.Object getIdentifier()
        Returns:
        The identifier in the request

      • updateNestedKeys

        protected void updateNestedKeys​(java.util.Map keys)