Package lumis.util

Class PortletParametersMap

  • All Implemented Interfaces:
    Serializable, Cloneable, Map<String,​String[]>
    public class PortletParametersMap
extends LinkedHashMap<String,​String[]>
    Implements a Map for parameters with the usual constraints specified in the JSR-168 interfaces, as in ActionResponse and PortletURL.

    The constraints are:

    • key must not be null and must be a String
    • value must not be null and must be a String[]

    If any of the constraints above are violated, an IllegalArgumentException is thrown when the parameter is tried to be set.

    The String array values are cloned, so changes in the given array instance will not affect the value stored in the map.

    For this behavior to be applied, the methods setParameter(String, String), setParameter(String, String[]) or setParameters(Map) must be used. The Map methods do not behave as stated above.

    Since:
    4.0.7
    Version:
    $Revision: 16976 $ $Date: 2015-02-20 15:36:20 -0200 (Fri, 20 Feb 2015) $
    See Also:
    Serialized Form

    • Constructor Detail

      • PortletParametersMap

        public PortletParametersMap()

      • PortletParametersMap

        public PortletParametersMap​(int initialCapacity)

    • Method Detail

      • setParameter

        public void setParameter​(String key,
                         String value)
        Sets a String parameter.

        This method replaces all parameters with the given key.

        Parameters:
        key - key of the parameter
        value - value of the parameter
        Throws:
        IllegalArgumentException - if key or value are null.
        Since:
        4.0.7

      • setParameter

        public void setParameter​(String key,
                         String[] values)
        Sets a String array parameter.

        This method replaces all parameters with the given key.

        Parameters:
        key - key of the parameter
        values - values of the parameter
        Throws:
        IllegalArgumentException - if key or value are null.
        Since:
        4.0.7

      • setParameters

        public void setParameters​(Map<String,​String[]> parameters)
        Sets a parameter map.

        All previously set render parameters are cleared.

        Parameters:
        parameters - Map containing the parameters. The keys in the parameter map must be of type String. The values in the parameter map must be of type String array (String[]).
        Throws:
        IllegalArgumentException - if parameters is null, if any of the key/values in the Map are null, if any of the keys is not a String, or if any of the values is not a String array.
        Since:
        4.0.7