org.apache.wicket
Class PageParameters

java.lang.Object
  extended by java.util.AbstractMap<K,V>
      extended by java.util.HashMap
          extended by org.apache.wicket.util.value.ValueMap
              extended by org.apache.wicket.PageParameters
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.Map, IValueMap

public final class PageParameters
extends ValueMap

A typesafe abstraction and container for parameters to a requested page. Page parameters in HTTP are query string values in the request URL. In other protocols, the parameters to a page might come from some other source.

Pages which take a PageParameters object as an argument to their constructor can be accessed directly from a URL and are known as "bookmarkable" pages since the URL is stable across sessions and can be stored in a browser's bookmark database.

Author:
Jonathan Locke
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class java.util.AbstractMap
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Field Summary
static PageParameters NULL
          Null value for page parameters
 
Fields inherited from class org.apache.wicket.util.value.ValueMap
EMPTY_MAP
 
Constructor Summary
PageParameters()
          Constructor
PageParameters(java.util.Map parameterMap)
          Copy constructor.
PageParameters(java.lang.String keyValuePairs)
          Construct.
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
 java.lang.Object put(java.lang.Object key, java.lang.Object value)
           
 
Methods inherited from class org.apache.wicket.util.value.ValueMap
add, clear, getBoolean, getCharSequence, getDouble, getDouble, getDuration, getInt, getInt, getKey, getLong, getLong, getString, getString, getStringArray, getStringValue, getTime, isImmutable, makeImmutable, putAll, remove, toString
 
Methods inherited from class java.util.HashMap
clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, size, values
 
Methods inherited from class java.util.AbstractMap
equals, hashCode
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface java.util.Map
containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, size, values
 

Field Detail

NULL

public static final PageParameters NULL
Null value for page parameters

Constructor Detail

PageParameters

public PageParameters()
Constructor


PageParameters

public PageParameters(java.util.Map parameterMap)
Copy constructor.

Parameters:
parameterMap - The map to copy
See Also:
ValueMap.ValueMap(java.util.Map)

PageParameters

public PageParameters(java.lang.String keyValuePairs)
Construct.

Parameters:
keyValuePairs - List of key value pairs separated by commas. For example, "param1=foo,param2=bar"
See Also:
ValueMap.ValueMap(String)

PageParameters

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

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object value)
Specified by:
put in interface java.util.Map
Specified by:
put in interface IValueMap
Overrides:
put in class ValueMap
See Also:
Map.put(java.lang.Object, java.lang.Object)


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