org.apache.wicket.request.mapper.parameter
Class PageParameters

java.lang.Object
  org.apache.wicket.request.mapper.parameter.PageParameters

All Implemented Interfaces:

java.io.Serializable

public class PageParameters
extends java.lang.Object
implements java.io.Serializable

Mutable class that holds parameters of a Page. Page parameters consist of indexed parameters and named parameters. Indexed parameters are URL segments before the query string. Named parameters are usually represented as query string params (i.e. ?arg1=var1&arg2=val)

Indexed vs Named Parameters: Suppose we mounted a page on /user and the following url was accessed /user/profile/bob?action=view&redirect=false. In this example profile and bob are indexed parameters with respective indexes 0 and 1. action and redirect are named parameters.

How those parameters are populated depends on the IRequestMappers

Author:

Matej Knopp

See Also:

Serialized Form

Nested Class Summary

static class

PageParameters.NamedPair Represents a named parameter entry.

Constructor Summary

PageParameters()
Construct.

PageParameters(PageParameters copy)
Copy constructor.

PageParameters(java.lang.String keyValuePairs)
Deprecated. use varios setter methods to set parameters

PageParameters(java.lang.String keyValuePairs, java.lang.String delimiter)
Deprecated. use varios setter methods to set parameters

Method Summary

PageParameters	add(java.lang.String name, java.lang.Object value) Adds value to named parameter with given name.
PageParameters	add(java.lang.String name, java.lang.Object value, int index) Adds named parameter to a specified position.
PageParameters	clearaNamed() Removes all named parameters.
PageParameters	clearIndexed() Removes all indexed parameters.
boolean	equals(java.lang.Object obj)
static boolean	equals(PageParameters p1, PageParameters p2) Compares two PageParameters objects.
StringValue	get(int index)
StringValue	get(java.lang.String name) Returns parameter value of named parameter with given name
java.util.List<PageParameters.NamedPair>	getAllNamed()
int	getIndexedCount()
java.util.Set<java.lang.String>	getNamedKeys() Return set of all named parameter names.
java.util.List<StringValue>	getValues(java.lang.String name) Return list of all values for named parameter with given name
boolean	isEmpty()
PageParameters	overwriteWith(PageParameters other) Copy the paga parameters
PageParameters	remove(int index) Removes indexed parameter on given index
PageParameters	remove(java.lang.String name) Removes named parameter with given name.
PageParameters	set(int index, java.lang.Object object) Sets the indexed parameter on given index
PageParameters	set(java.lang.String name, java.lang.Object value) Sets the value for named parameter with given name.
PageParameters	set(java.lang.String name, java.lang.Object value, int index) Sets the named parameter on specified position.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageParameters

public PageParameters()

Construct.

PageParameters

public PageParameters(PageParameters copy)

Copy constructor.

Parameters:

copy -

PageParameters

@Deprecated
public PageParameters(java.lang.String keyValuePairs)

Deprecated. use varios setter methods to set parameters

Construct.

Parameters:

keyValuePairs - List of key value pairs separated by commas. For example, "param1=foo,param2=bar"

See Also:

ValueMap.ValueMap(String)

PageParameters

@Deprecated
public PageParameters(java.lang.String keyValuePairs,
                                 java.lang.String delimiter)

Deprecated. use varios setter methods to set parameters

Construct.

Parameters:

keyValuePairs - List of key value pairs separated by commas. For example, "param1=foo,param2=bar"

delimiter - Delimiter string used to separate key/value pairs

See Also:

ValueMap.ValueMap(String)

Method Detail

getIndexedCount

public int getIndexedCount()

Returns:

count of indexed parameters

set

public PageParameters set(int index,
                          java.lang.Object object)

Sets the indexed parameter on given index

Parameters:

index -

object -

Returns:

this

get

public StringValue get(int index)

Parameters:

index -

Returns:

indexed parameter on given index

remove

public PageParameters remove(int index)

Removes indexed parameter on given index

Parameters:

index -

Returns:

this

getNamedKeys

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

Return set of all named parameter names.

Returns:

named parameter names

get

public StringValue get(java.lang.String name)

Returns parameter value of named parameter with given name

Parameters:

name -

Returns:

parameter value

getValues

public 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

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

Returns:

All named parameters in exact order.

remove

public PageParameters remove(java.lang.String name)

Removes named parameter with given name.

Parameters:

name -

Returns:

this

add

public PageParameters add(java.lang.String name,
                          java.lang.Object value)

Adds value to named parameter with given name.

Parameters:

name -

value -

Returns:

this

add

public PageParameters 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

public PageParameters 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

public PageParameters set(java.lang.String name,
                          java.lang.Object value)

Sets the value for named parameter with given name.

Parameters:

name -

value -

Returns:

this

clearIndexed

public PageParameters clearIndexed()

Removes all indexed parameters.

Returns:

this

clearaNamed

public PageParameters clearaNamed()

Removes all named parameters.

Returns:

this

overwriteWith

public PageParameters overwriteWith(PageParameters other)

Copy the paga parameters

Parameters:

other -

Returns:

this

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

equals

public static boolean equals(PageParameters p1,
                             PageParameters p2)

Compares two PageParameters objects.

Parameters:

p1 -

p2 -

Returns:

true if the objects are equal, false otherwise.

isEmpty

public boolean isEmpty()

Returns:

true if the parameters are empty, false otherwise.