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

java.lang.Object
  extended by 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)

How those parameters are populated depends on the IRequestMappers

Author:
Matej Knopp
See Also:
Serialized Form

Nested Class Summary
static class PageParameters.NamedParameterPair
          Represents a named parameter entry.
 
Constructor Summary
PageParameters()
          Construct.
PageParameters(PageParameters copy)
          Copy constructor.
PageParameters(java.lang.String keyValuePairs)
          Deprecated. 
PageParameters(java.lang.String keyValuePairs, java.lang.String delimiter)
          Deprecated. Please use RequestUtils#decodeParameters(String, ValueMap) to decode a request URL, or ValueMap.ValueMap(String, String) for other usecases.
 
Method Summary
 void addNamedParameter(java.lang.String name, java.lang.Object value)
          Adds value to named parameter with given name.
 void addNamedParameter(java.lang.String name, java.lang.Object value, int index)
          Adds named parameter to a specified position.
 void assign(PageParameters other)
          Copy the paga parameters
 void clearIndexedParameters()
          Removes all indexed parameters.
 void clearNamedParameters()
          Removes all named parameters.
 boolean equals(java.lang.Object obj)
           
static boolean equals(PageParameters p1, PageParameters p2)
          Compares two PageParameters objects.
 StringValue getIndexedParameter(int index)
           
 int getIndexedParamsCount()
           
 StringValue getNamedParameter(java.lang.String name)
          Returns parameter value of named parameter with given name
 java.util.Set<java.lang.String> getNamedParameterKeys()
          Return set of all named parameter names.
 java.util.List<PageParameters.NamedParameterPair> getNamedParameters()
           
 java.util.List<StringValue> getNamedParameters(java.lang.String name)
          Return list of all values for named parameter with given name
 boolean isEmpty()
           
 void removeIndexedParameter(int index)
          Removes indexed parameter on given index
 void removeNamedParameter(java.lang.String name)
          Removes named parameter with given name.
 void setIndexedParameter(int index, java.lang.Object object)
          Sets the indexed parameter on given index
 void setNamedParameter(java.lang.String name, java.lang.Object value)
          Sets the value for named parameter with given name.
 void setNamedParameter(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. 

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. Please use RequestUtils#decodeParameters(String, ValueMap) to decode a request URL, or ValueMap.ValueMap(String, String) for other usecases.

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

getIndexedParamsCount

public int getIndexedParamsCount()
Returns:
count of indexed parameters

setIndexedParameter

public void setIndexedParameter(int index,
                                java.lang.Object object)
Sets the indexed parameter on given index

Parameters:
index -
object -

getIndexedParameter

public StringValue getIndexedParameter(int index)
Parameters:
index -
Returns:
indexed parameter on given index

removeIndexedParameter

public void removeIndexedParameter(int index)
Removes indexed parameter on given index

Parameters:
index -

getNamedParameterKeys

public java.util.Set<java.lang.String> getNamedParameterKeys()
Return set of all named parameter names.

Returns:
named parameter names

getNamedParameter

public StringValue getNamedParameter(java.lang.String name)
Returns parameter value of named parameter with given name

Parameters:
name -
Returns:
parameter value

getNamedParameters

public java.util.List<StringValue> getNamedParameters(java.lang.String name)
Return list of all values for named parameter with given name

Parameters:
name -
Returns:
list of parameter values

getNamedParameters

public java.util.List<PageParameters.NamedParameterPair> getNamedParameters()
Returns:
All named parameters in exact order.

removeNamedParameter

public void removeNamedParameter(java.lang.String name)
Removes named parameter with given name.

Parameters:
name -

addNamedParameter

public void addNamedParameter(java.lang.String name,
                              java.lang.Object value)
Adds value to named parameter with given name.

Parameters:
name -
value -

addNamedParameter

public void addNamedParameter(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 -

setNamedParameter

public void setNamedParameter(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 -

setNamedParameter

public void setNamedParameter(java.lang.String name,
                              java.lang.Object value)
Sets the value for named parameter with given name.

Parameters:
name -
value -

clearIndexedParameters

public void clearIndexedParameters()
Removes all indexed parameters.


clearNamedParameters

public void clearNamedParameters()
Removes all named parameters.


assign

public void assign(PageParameters other)
Copy the paga parameters

Parameters:
other -

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.


Copyright © 2004-2010 Apache Software Foundation. All Rights Reserved.