|
||||||||||
| 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 IRequestMappers
| Nested Class Summary | |
|---|---|
static class |
PageParameters.NamedPair
Represents a named parameter entry. |
| Constructor Summary | |
|---|---|
PageParameters()
Construct. |
|
PageParameters(PageParameters copy)
Copy constructor. |
|
PageParameters(String keyValuePairs)
Deprecated. use various setter methods to set parameters |
|
PageParameters(String keyValuePairs,
String delimiter)
Deprecated. use various setter methods to set parameters |
|
| 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 |
clearIndexed()
Removes all indexed parameters. |
PageParameters |
clearNamed()
Removes all named parameters. |
boolean |
equals(Object obj)
|
static boolean |
equals(PageParameters p1,
PageParameters p2)
Compares two PageParameters objects. |
StringValue |
get(int index)
|
StringValue |
get(String name)
Returns parameter value of named parameter with given name |
List<PageParameters.NamedPair> |
getAllNamed()
|
int |
getIndexedCount()
|
Set<String> |
getNamedKeys()
Return set of all named parameter names. |
int |
getPosition(String name)
Returns the position of a named parameter. |
List<StringValue> |
getValues(String name)
Return list of all values for named parameter with given name |
int |
hashCode()
|
boolean |
isEmpty()
|
PageParameters |
mergeWith(PageParameters other)
Merges the page parameters into this, overwriting existing values |
PageParameters |
overwriteWith(PageParameters other)
Copy the page parameters |
PageParameters |
remove(int index)
Removes indexed parameter on given index |
PageParameters |
remove(String name)
Removes named parameter with given name. |
PageParameters |
remove(String name,
String... values)
Removes named parameter with given name. |
PageParameters |
set(int index,
Object object)
Sets the indexed parameter on given index |
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. |
String |
toString()
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public PageParameters()
public PageParameters(PageParameters copy)
copy - @Deprecated public PageParameters(String keyValuePairs)
keyValuePairs - List of key value pairs separated by commas. For example, "param1=foo,param2=bar"ValueMap.ValueMap(String)
@Deprecated
public PageParameters(String keyValuePairs,
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,
Object object)
IIndexedParameters
set in interface IIndexedParametersIIndexedParameters.set(int, java.lang.Object)public StringValue get(int index)
get in interface IIndexedParametersIIndexedParameters.get(int)public PageParameters remove(int index)
IIndexedParameters
remove in interface IIndexedParametersIIndexedParameters.remove(int)public Set<String> getNamedKeys()
INamedParameters
getNamedKeys in interface INamedParametersINamedParameters.getNamedKeys()public StringValue get(String name)
INamedParameters
get in interface INamedParametersINamedParameters.get(java.lang.String)public List<StringValue> getValues(String name)
INamedParameters
getValues in interface INamedParametersINamedParameters.getValues(java.lang.String)public List<PageParameters.NamedPair> getAllNamed()
getAllNamed in interface INamedParametersINamedParameters.getAllNamed()public int getPosition(String name)
INamedParameters
getPosition in interface INamedParametersname - the name of the parameter to look for
-1 if there is no parameter with that name.INamedParameters.getPosition(String)public PageParameters remove(String name)
INamedParameters
remove in interface INamedParametersname - the name of the parameter to remove
INamedParameters.remove(java.lang.String)
public PageParameters remove(String name,
String... values)
INamedParameters
remove in interface INamedParametersname - the name of the parameter to removevalues - values used as criteria. The parameter will be removed only if its value is equal
to any of the criteria.
INamedParameters.remove(java.lang.String,
java.lang.String...)
public PageParameters add(String name,
Object value)
INamedParameters
add in interface INamedParametersINamedParameters.add(java.lang.String,
java.lang.Object)
public PageParameters add(String name,
Object value,
int index)
INamedParametersIRequestMappers may or may not take
the order into account.
add in interface INamedParametersINamedParameters.add(java.lang.String,
java.lang.Object, int)
public PageParameters set(String name,
Object value,
int index)
INamedParametersIRequestMappers may or may not
take the order into account.
set in interface INamedParametersINamedParameters.set(java.lang.String,
java.lang.Object, int)
public PageParameters set(String name,
Object value)
INamedParameters
set in interface INamedParametersINamedParameters.set(java.lang.String,
java.lang.Object)public PageParameters clearIndexed()
IIndexedParameters
clearIndexed in interface IIndexedParametersIIndexedParameters.clearIndexed()public PageParameters clearNamed()
INamedParameters
clearNamed in interface INamedParametersINamedParameters.clearNamed()public PageParameters overwriteWith(PageParameters other)
other -
public PageParameters mergeWith(PageParameters other)
other -
public int hashCode()
hashCode in class Objectpublic boolean equals(Object obj)
equals in class 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.public String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||