|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.wicket.request.mapper.parameter.PageParameters
public class PageParameters
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 IRequestMapper
s
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 |
---|
public PageParameters()
public PageParameters(PageParameters copy)
copy
- @Deprecated public PageParameters(java.lang.String keyValuePairs)
keyValuePairs
- List of key value pairs separated by commas. For example, "param1=foo,param2=bar"ValueMap.ValueMap(String)
@Deprecated public PageParameters(java.lang.String keyValuePairs, java.lang.String delimiter)
keyValuePairs
- List of key value pairs separated by commas. For example, "param1=foo,param2=bar"delimiter
- Delimiter string used to separate key/value pairsValueMap.ValueMap(String)
Method Detail |
---|
public int getIndexedCount()
public PageParameters set(int index, java.lang.Object object)
index
- object
-
public StringValue get(int index)
index
-
public PageParameters remove(int index)
index
-
public java.util.Set<java.lang.String> getNamedKeys()
public StringValue get(java.lang.String name)
name
-
public java.util.List<StringValue> getValues(java.lang.String name)
name
-
public java.util.List<PageParameters.NamedPair> getAllNamed()
public PageParameters remove(java.lang.String name)
name
-
public PageParameters add(java.lang.String name, java.lang.Object value)
name
- value
-
public PageParameters add(java.lang.String name, java.lang.Object value, int index)
IRequestMapper
s may or may not take
the order into account.
name
- value
- index
-
public PageParameters set(java.lang.String name, java.lang.Object value, int index)
IRequestMapper
s may or may not
take the order into account.
name
- value
- index
-
public PageParameters set(java.lang.String name, java.lang.Object value)
name
- value
-
public PageParameters clearIndexed()
public PageParameters clearaNamed()
public PageParameters overwriteWith(PageParameters other)
other
-
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Object.equals(java.lang.Object)
public static boolean equals(PageParameters p1, PageParameters p2)
PageParameters
objects.
p1
- p2
-
true
if the objects are equal, false
otherwise.public boolean isEmpty()
true
if the parameters are empty, false
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |