org.apache.wicket.request.mapper.parameter
Interface INamedParameters

All Known Implementing Classes:

PageParameters

public interface INamedParameters

Container for parameters that are identified by their name

Author:

igor

Method Summary

INamedParameters	add(java.lang.String name, java.lang.Object value) Adds value to named parameter with given name.
INamedParameters	add(java.lang.String name, java.lang.Object value, int index) Adds named parameter to a specified position.
INamedParameters	clearNamed() Removes all named parameters.
StringValue	get(java.lang.String name) Returns parameter value of named parameter with given name
java.util.List<PageParameters.NamedPair>	getAllNamed()
java.util.Set<java.lang.String>	getNamedKeys() Return set of all named parameter names.
int	getPosition(java.lang.String name) Returns the position of a named parameter.
java.util.List<StringValue>	getValues(java.lang.String name) Return list of all values for named parameter with given name
INamedParameters	remove(java.lang.String name) Deprecated. use remove(String, String...)
INamedParameters	remove(java.lang.String name, java.lang.String... values) Removes named parameter with given name.
INamedParameters	set(java.lang.String name, java.lang.Object value) Sets the value for named parameter with given name.
INamedParameters	set(java.lang.String name, java.lang.Object value, int index) Sets the named parameter on specified position.

Method Detail

getNamedKeys

java.util.Set<java.lang.String> getNamedKeys()

Return set of all named parameter names.

Returns:

named parameter names

get

StringValue get(java.lang.String name)

Returns parameter value of named parameter with given name

Parameters:

name -

Returns:

parameter value

getValues

java.util.List<StringValue> getValues(java.lang.String name)

Return list of all values for named parameter with given name

Parameters:

name -

Returns:

list of parameter values

getAllNamed

java.util.List<PageParameters.NamedPair> getAllNamed()

Returns:

All named parameters in exact order.

getPosition

int getPosition(java.lang.String name)

Returns the position of a named parameter.

Parameters:

name - the name of the parameter to look for

Returns:

the position of the parameter. -1 if there is no parameter with that name.

remove

@Deprecated
INamedParameters remove(java.lang.String name)

Deprecated. use remove(String, String...)

Removes named parameter with given name.

Parameters:

name - the name of the parameter to remove

Returns:

this

remove

INamedParameters remove(java.lang.String name,
                        java.lang.String... values)

Removes named parameter with given name.

Parameters:

name - the name of the parameter to remove

values - values used as criteria. The parameter will be removed only if its value is equal to any of the criteria.

Returns:

this

add

INamedParameters add(java.lang.String name,
                     java.lang.Object value)

Adds value to named parameter with given name.

Parameters:

name -

value -

Returns:

this

add

INamedParameters add(java.lang.String name,
                     java.lang.Object value,
                     int index)

Adds named parameter to a specified position. The IRequestMappers may or may not take the order into account.

Parameters:

name -

value -

index -

Returns:

this

set

INamedParameters set(java.lang.String name,
                     java.lang.Object value,
                     int index)

Sets the named parameter on specified position. The IRequestMappers may or may not take the order into account.

Parameters:

name -

value -

index -

Returns:

this

set

INamedParameters set(java.lang.String name,
                     java.lang.Object value)

Sets the value for named parameter with given name.

Parameters:

name -

value -

Returns:

this

clearNamed

INamedParameters clearNamed()

Removes all named parameters.

Returns:

this