Skip to main content

[JIRA] Created: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

  • From: "msnicklous (JIRA)" < >
  • To:
  • Subject: [JIRA] Created: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters
  • Date: Thu, 2 May 2013 14:07:58 +0000 (UTC)
  • Auto-submitted: auto-generated

Errata: Clarify inconsistencies regarding getting and setting parameters
------------------------------------------------------------------------

                 Key: PORTLETSPEC3-8
                 URL: https://java.net/jira/browse/PORTLETSPEC3-8
             Project: portletspec3
          Issue Type: Improvement
          Components: JSR 286 Portlet Specification Errata
            Reporter: msnicklous
            Priority: Minor


Reading the spec document on parameters and comparing it with the javadoc on
"get...Parameter..." and "set...Parameter..." calls on various Response, 
Request, and
URL classes, it seems to me that there are a number of inconsistencies that 
should
be addressed, for example:

1) Is a parameter allowed to have a value of null?
2) Under which cases (if any) should setting a parameter to a value of null 
remove the parameter?
3) In which cases exactly are public parameters get and set?
4) In which cases are public render parameters set or updated?
5) In which cases are public render parameters removed?
6) Should the "getParameterMap" methods always return an immutable map?
7) probably more that I haven't noticed yet ... 

To #6 - 

The javadoc for PortletRequest.getParameterMap states:
-------------------------
    Returns:
        an immutable Map containing parameter names as keys and parameter 
values as map 
        values, or an empty Map if no parameters exist. 
        The keys in the parameter map are of type String. 
        The values in the parameter map are of type String array (String[]).
-------------------------

While the javadoc for BaseURL.getParameterMap states:
-------------------------
Returns:
    Map containing parameter names as keys and parameter values as map 
    values, or an empty Map if no parameters exist. 
    The keys in the parameter map are of type String. 
    The values in the parameter map are of type String array (String[]).
-------------------------

Shouldn't the returned Map values be consistently immutable? 

If not, and if we want to be able to update the actual parameters by updating 
the
Map returned by BaseURL.getParameterMap, it needs to be described clearly.


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
https://java.net/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        


[JIRA] Created: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

msnicklous (JIRA) 05/02/2013

[JIRA] Commented: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

Neil Griffin (JIRA) 05/13/2013

[JIRA] Updated: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

msnicklous (JIRA) 05/21/2013

[JIRA] Commented: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

Neil Griffin (JIRA) 05/21/2013

[JIRA] Issue Comment Edited: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

Neil Griffin (JIRA) 05/21/2013

[JIRA] Issue Comment Edited: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

Neil Griffin (JIRA) 05/21/2013

[JIRA] Commented: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

Neil Griffin (JIRA) 05/21/2013

[JIRA] Commented: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

mfreedma (JIRA) 05/21/2013

[JIRA] Commented: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

Neil Griffin (JIRA) 05/28/2013

[JIRA] Issue Comment Edited: (PORTLETSPEC3-8) Errata: Clarify inconsistencies regarding getting and setting parameters

Neil Griffin (JIRA) 05/28/2013
 
 
Close
loading
Please Confirm
Close