lumis.util
Class PortletParametersMap

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<String,String[]>
          lumis.util.PortletParametersMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,String[]>

public class PortletParametersMap
extends HashMap<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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

PortletParametersMap()

PortletParametersMap(int initialCapacity)

Method Summary

PortletParametersMap	clone() Clones this PortletParametersMap, also cloning the arrays in the values to prevent the clone from affecting the original.
void	setParameter(String key, String value) Sets a String parameter.
void	setParameter(String key, String[] values) Sets a String array parameter.
void	setParameters(Map<String,String[]> parameters) Sets a parameter map.

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

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

clone

public PortletParametersMap clone()

Clones this PortletParametersMap, also cloning the arrays in the values to prevent the clone from affecting the original.

The keys and the array elements are not cloned since they are immutable.

Overrides:

clone in class HashMap<String,String[]>

Returns:

the cloned PortletParametersMap.

Since:

5.5.0