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
 PageParameters add(String name, Object value)
          Adds value to named parameter with given name.
 PageParameters add(String name, Object value, int index)
          Adds named parameter to a specified position.
 PageParameters clearNamed()
          Removes all named parameters.
 StringValue get(String name)
          Returns parameter value of named parameter with given name
 List<PageParameters.NamedPair> getAllNamed()
           
 Set<String> getNamedKeys()
          Return set of all named parameter names.
 List<StringValue> getValues(String name)
          Return list of all values for named parameter with given name
 PageParameters remove(String name)
          Removes named parameter with given name.
 PageParameters set(String name, Object value)
          Sets the value for named parameter with given name.
 PageParameters set(String name, Object value, int index)
          Sets the named parameter on specified position.
 

Method Detail

getNamedKeys

Set<String> getNamedKeys()
Return set of all named parameter names.

Returns:
named parameter names

get

StringValue get(String name)
Returns parameter value of named parameter with given name

Parameters:
name -
Returns:
parameter value

getValues

List<StringValue> getValues(String name)
Return list of all values for named parameter with given name

Parameters:
name -
Returns:
list of parameter values

getAllNamed

List<PageParameters.NamedPair> getAllNamed()
Returns:
All named parameters in exact order.

remove

PageParameters remove(String name)
Removes named parameter with given name.

Parameters:
name -
Returns:
this

add

PageParameters add(String name,
                   Object value)
Adds value to named parameter with given name.

Parameters:
name -
value -
Returns:
this

add

PageParameters add(String name,
                   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

PageParameters set(String name,
                   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

PageParameters set(String name,
                   Object value)
Sets the value for named parameter with given name.

Parameters:
name -
value -
Returns:
this

clearNamed

PageParameters clearNamed()
Removes all named parameters.

Returns:
this


Copyright © 2006-2011 Apache Software Foundation. All Rights Reserved.