com.ibm.portal.resolver.accessors.url
Interface ParameterAccessorController

All Superinterfaces:

ParameterAccessor

All Known Subinterfaces:

PocURL, RenderEventResponse

public interface ParameterAccessorController
extends ParameterAccessor

Represents a modifiable set of String parameters

Since:

6.1.0

Method Summary

void	addParameter(java.lang.String key, java.lang.String value) Appends the parameter value to those values that are already part of the key
void	addParameters(java.lang.String key, java.lang.String... values) Appends the parameter value to those values that are already part of the key
java.util.Map<java.lang.String,java.lang.String[]>	getParameters() Returns a map of portlet parameters (String -> String[]).
java.lang.String[]	removeParameter(java.lang.String key) Removes all parameters for the given key
void	setParameter(java.lang.String key, java.lang.String value) Replaces the parameters for the key with the new values
void	setParameters(java.lang.String key, java.lang.String... values) Replaces the parameters for the key with the new valuess

Methods inherited from interface com.ibm.portal.resolver.accessors.url.ParameterAccessor

getParameter, getParameter, getParameters, getParameters

Method Detail

addParameter

void addParameter(java.lang.String key,
                  java.lang.String value)

Appends the parameter value to those values that are already part of the key

Parameters:

key - the key

value - the value to append

addParameters

void addParameters(java.lang.String key,
                   java.lang.String... values)

Appends the parameter value to those values that are already part of the key

Parameters:

key - the key

values - the values to append

getParameters

java.util.Map<java.lang.String,java.lang.String[]> getParameters()

Returns a map of portlet parameters (String -> String[]). It is guaranteed that this map is modifiable.

Specified by:

getParameters in interface ParameterAccessor

Returns:

A modifiable map of parameters. Does not return null .

removeParameter

java.lang.String[] removeParameter(java.lang.String key)

Removes all parameters for the given key

Parameters:

key - the key

Returns:

the previous parameters or null

setParameter

void setParameter(java.lang.String key,
                  java.lang.String value)

Replaces the parameters for the key with the new values

Parameters:

key - the key

value - the new value

setParameters

void setParameters(java.lang.String key,
                   java.lang.String... values)

Replaces the parameters for the key with the new valuess

Parameters:

key - the key

values - the new values