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

All Known Subinterfaces:

EventRequest, ParameterAccessorController, PocURL, RenderEventRequest, RenderEventResponse, ResourceEventRequest

public interface ParameterAccessor

Represents an object that provides access to String parameters

Since:

6.1.0

Method Summary

java.lang.String	getParameter(java.lang.String key) Returns the first parameter of a parameter array that matches the key
java.lang.String	getParameter(java.lang.String key, java.lang.String aDefault) Returns the first parameter of a parameter array that matches the key
java.util.Map<java.lang.String,java.lang.String[]>	getParameters() Returns an unmodifiable version of the parameters, never null, but potentially the empty map.
java.lang.String[]	getParameters(java.lang.String key) Returns the parameters for the given key
java.lang.String[]	getParameters(java.lang.String key, java.lang.String... aDefaults) Returns the parameters for the given key

Method Detail

getParameter

java.lang.String getParameter(java.lang.String key)

Returns the first parameter of a parameter array that matches the key

Parameters:

key - key

Returns:

the first parameter or null

getParameter

java.lang.String getParameter(java.lang.String key,
                              java.lang.String aDefault)

Returns the first parameter of a parameter array that matches the key

Parameters:

key - key

aDefault - the default value to be returned

Returns:

the first parameter or null

getParameters

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

Returns an unmodifiable version of the parameters, never null, but potentially the empty map.

The key is of type String, the values of type String[]

Returns:

parameter map, not null

getParameters

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

Returns the parameters for the given key

Parameters:

key - key, not null

Returns:

the parameters or null

getParameters

java.lang.String[] getParameters(java.lang.String key,
                                 java.lang.String... aDefaults)

Returns the parameters for the given key

Parameters:

key - key, not null

aDefaults - the default values returned, if the key cannot be found

Returns:

the parameters or null