org.apache.wicket.util.value
Class ValueMap

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap
          org.apache.wicket.util.value.ValueMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map, IValueMap

Direct Known Subclasses:

AttributeMap, PageParameters

public class ValueMap
extends java.util.HashMap
implements IValueMap

A IValueMap implementation that holds values, parses Strings, and exposes a variety of convenience methods.

In addition to a no-arg constructor and a copy constructor that takes a Map argument, ValueMaps can be constructed using a parsing constructor. ValueMap(String) will parse values from the string in comma separated key/value assignment pairs. For example, new ValueMap("a=9,b=foo").

Values can be retrieved from the ValueMap in the usual way or with methods that do handy conversions to various types, including String, StringValue, int, long, double, Time and Duration.

The makeImmutable method will make the underlying Map immutable. Further attempts to change the Map will result in a RuntimeException.

The toString method converts a ValueMap object to a readable key/value string for diagnostics.

Since:

1.2.6

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 ValueMap

EMPTY_MAP an empty ValueMap.

Constructor Summary

ValueMap()
Constructs empty ValueMap.

ValueMap(java.util.Map map)
Copy constructor.

ValueMap(java.lang.String keyValuePairs)
Constructor.

ValueMap(java.lang.String keyValuePairs, java.lang.String delimiter)
Constructor.

ValueMap(java.lang.String keyValuePairs, java.lang.String delimiter, MetaPattern valuePattern)
Constructor.

Method Summary

java.lang.Object	add(java.lang.String key, java.lang.String value) Adds the value to this ValueMap with the given key.
void	clear()
boolean	getBoolean(java.lang.String key) Retrieves a boolean value by key.
java.lang.CharSequence	getCharSequence(java.lang.String key) Retrieves a CharSequence by key.
double	getDouble(java.lang.String key) Retrieves a double value by key.
double	getDouble(java.lang.String key, double defaultValue) Retrieves a double value by key, using a default value if not found.
Duration	getDuration(java.lang.String key) Retrieves a Duration by key.
int	getInt(java.lang.String key) Retrieves an int value by key.
int	getInt(java.lang.String key, int defaultValue) Retrieves an int value by key, using a default value if not found.
java.lang.String	getKey(java.lang.String key) Provided that the hash key is a String and you need to access the value ignoring the key's case (upper- or lowercase letters), then you may use this method to get the correct writing.
long	getLong(java.lang.String key) Retrieves a long value by key.
long	getLong(java.lang.String key, long defaultValue) Retrieves a long value by key, using a default value if not found.
java.lang.String	getString(java.lang.String key) Retrieves a String by key.
java.lang.String	getString(java.lang.String key, java.lang.String defaultValue) Retrieves a String by key, using a default value if not found.
java.lang.String[]	getStringArray(java.lang.String key) Retrieves a String array by key.
StringValue	getStringValue(java.lang.String key) Retrieves a StringValue object by key.
Time	getTime(java.lang.String key) Retrieves a Time object by key.
boolean	isImmutable() Returns whether or not this IValueMap is immutable.
IValueMap	makeImmutable() Makes this IValueMap immutable by changing the underlying map representation to a Collections.unmodifiableMap.
java.lang.Object	put(java.lang.Object key, java.lang.Object value)
void	putAll(java.util.Map map)
java.lang.Object	remove(java.lang.Object key)
java.lang.String	toString() Generates a String representation of this object.

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

EMPTY_MAP

public static final ValueMap EMPTY_MAP

an empty ValueMap.

Constructor Detail

ValueMap

public ValueMap()

Constructs empty ValueMap.

ValueMap

public ValueMap(java.util.Map map)

Copy constructor.

Parameters:

map - the ValueMap to copy

ValueMap

public ValueMap(java.lang.String keyValuePairs)

Constructor.

NOTE: Please use RequestUtils.decodeParameters() if you wish to properly decode a request URL.

Parameters:

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

ValueMap

public ValueMap(java.lang.String keyValuePairs,
                java.lang.String delimiter)

Constructor.

NOTE: Please use RequestUtils.decodeParameters() if you wish to properly decode a request URL.

Parameters:

keyValuePairs - list of key/value pairs separated by a given delimiter. For example, "param1=foo,param2=bar" where delimiter is ",".

delimiter - delimiter String used to separate key/value pairs

ValueMap

public ValueMap(java.lang.String keyValuePairs,
                java.lang.String delimiter,
                MetaPattern valuePattern)

Constructor.

Parameters:

keyValuePairs - list of key/value pairs separated by a given delimiter. For example, "param1=foo,param2=bar" where delimiter is ",".

delimiter - delimiter string used to separate key/value pairs

valuePattern - pattern for value. To pass a simple regular expression, pass "new MetaPattern(regexp)".

Method Detail

clear

public final void clear()

Specified by:

clear in interface java.util.Map

Specified by:

clear in interface IValueMap

Overrides:

clear in class java.util.HashMap

See Also:

Map.clear()

getBoolean

public final boolean getBoolean(java.lang.String key)
                         throws StringValueConversionException

Description copied from interface: IValueMap

Retrieves a boolean value by key.

Specified by:

getBoolean in interface IValueMap

Parameters:

key - the key

Returns:

the value

Throws:

StringValueConversionException

See Also:

IValueMap.getBoolean(String)

getDouble

public final double getDouble(java.lang.String key)
                       throws StringValueConversionException

Description copied from interface: IValueMap

Retrieves a double value by key.

Specified by:

getDouble in interface IValueMap

Parameters:

key - the key

Returns:

the value

Throws:

StringValueConversionException

See Also:

IValueMap.getDouble(String)

getDouble

public final double getDouble(java.lang.String key,
                              double defaultValue)
                       throws StringValueConversionException

Description copied from interface: IValueMap

Retrieves a double value by key, using a default value if not found.

Specified by:

getDouble in interface IValueMap

Parameters:

key - the key

defaultValue - value to use if no value is in this IValueMap

Returns:

the value

Throws:

StringValueConversionException

See Also:

IValueMap.getDouble(String, double)

getDuration

public final Duration getDuration(java.lang.String key)
                           throws StringValueConversionException

Description copied from interface: IValueMap

Retrieves a Duration by key.

Specified by:

getDuration in interface IValueMap

Parameters:

key - the key

Returns:

the Duration value

Throws:

StringValueConversionException

See Also:

IValueMap.getDuration(String)

getInt

public final int getInt(java.lang.String key)
                 throws StringValueConversionException

Description copied from interface: IValueMap

Retrieves an int value by key.

Specified by:

getInt in interface IValueMap

Parameters:

key - the key

Returns:

the value

Throws:

StringValueConversionException

See Also:

IValueMap.getInt(String)

getInt

public final int getInt(java.lang.String key,
                        int defaultValue)
                 throws StringValueConversionException

Description copied from interface: IValueMap

Retrieves an int value by key, using a default value if not found.

Specified by:

getInt in interface IValueMap

Parameters:

key - the key

defaultValue - value to use if no value is in this IValueMap

Returns:

the value

Throws:

StringValueConversionException

See Also:

IValueMap.getInt(String, int)

getLong

public final long getLong(java.lang.String key)
                   throws StringValueConversionException

Description copied from interface: IValueMap

Retrieves a long value by key.

Specified by:

getLong in interface IValueMap

Parameters:

key - the key

Returns:

the value

Throws:

StringValueConversionException

See Also:

IValueMap.getLong(String)

getLong

public final long getLong(java.lang.String key,
                          long defaultValue)
                   throws StringValueConversionException

Description copied from interface: IValueMap

Retrieves a long value by key, using a default value if not found.

Specified by:

getLong in interface IValueMap

Parameters:

key - the key

defaultValue - value to use if no value in this IValueMap

Returns:

the value

Throws:

StringValueConversionException

See Also:

IValueMap.getLong(String, long)

getString

public final java.lang.String getString(java.lang.String key,
                                        java.lang.String defaultValue)

Description copied from interface: IValueMap

Retrieves a String by key, using a default value if not found.

Specified by:

getString in interface IValueMap

Parameters:

key - the key

defaultValue - default value to return if value is null

Returns:

the String

See Also:

IValueMap.getString(String, String)

getString

public final java.lang.String getString(java.lang.String key)

Description copied from interface: IValueMap

Retrieves a String by key.

Specified by:

getString in interface IValueMap

Parameters:

key - the key

Returns:

the String

See Also:

IValueMap.getString(String)

getCharSequence

public final java.lang.CharSequence getCharSequence(java.lang.String key)

Description copied from interface: IValueMap

Retrieves a CharSequence by key.

Specified by:

getCharSequence in interface IValueMap

Parameters:

key - the key

Returns:

the CharSequence

See Also:

IValueMap.getCharSequence(String)

getStringArray

public java.lang.String[] getStringArray(java.lang.String key)

Description copied from interface: IValueMap

Retrieves a String array by key. If the value was a String[] it will be returned directly. If it was a String it will be converted to a String array of length one. If it was an array of another type, a String array will be made and each element will be converted to a String.

Specified by:

getStringArray in interface IValueMap

Parameters:

key - the key

Returns:

the String array of that key

See Also:

IValueMap.getStringArray(String)

getStringValue

public StringValue getStringValue(java.lang.String key)

Description copied from interface: IValueMap

Retrieves a StringValue object by key.

Specified by:

getStringValue in interface IValueMap

Parameters:

key - the key

Returns:

the StringValue object

See Also:

IValueMap.getStringValue(String)

getTime

public final Time getTime(java.lang.String key)
                   throws StringValueConversionException

Description copied from interface: IValueMap

Retrieves a Time object by key.

Specified by:

getTime in interface IValueMap

Parameters:

key - the key

Returns:

the Time object

Throws:

StringValueConversionException

See Also:

IValueMap.getTime(String)

isImmutable

public final boolean isImmutable()

Description copied from interface: IValueMap

Returns whether or not this IValueMap is immutable.

Specified by:

isImmutable in interface IValueMap

Returns:

whether or not this IValueMap is immutable

See Also:

IValueMap.isImmutable()

makeImmutable

public final IValueMap makeImmutable()

Description copied from interface: IValueMap

Makes this IValueMap immutable by changing the underlying map representation to a Collections.unmodifiableMap. After calling this method, any attempt to modify this IValueMap will result in a RuntimeException being thrown by the Collections framework.

Specified by:

makeImmutable in interface IValueMap

Returns:

this IValueMap

See Also:

IValueMap.makeImmutable()

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 java.util.HashMap

See Also:

Map.put(java.lang.Object, java.lang.Object)

add

public final java.lang.Object add(java.lang.String key,
                                  java.lang.String value)

Adds the value to this ValueMap with the given key. If the key already is in the ValueMap it will combine the values into a String array, else it will just store the value itself.

Parameters:

key - the key to store the value under

value - the value that must be added/merged to the ValueMap

Returns:

the value itself if there was no previous value, or a String array with the combined values

putAll

public void putAll(java.util.Map map)

Specified by:

putAll in interface java.util.Map

Specified by:

putAll in interface IValueMap

Overrides:

putAll in class java.util.HashMap

See Also:

Map.putAll(java.util.Map)

remove

public java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map

Specified by:

remove in interface IValueMap

Overrides:

remove in class java.util.HashMap

See Also:

Map.remove(java.lang.Object)

getKey

public java.lang.String getKey(java.lang.String key)

Description copied from interface: IValueMap

Provided that the hash key is a String and you need to access the value ignoring the key's case (upper- or lowercase letters), then you may use this method to get the correct writing.

Specified by:

getKey in interface IValueMap

Parameters:

key - the key

Returns:

the key with the correct writing

See Also:

IValueMap.getKey(String)

toString

public java.lang.String toString()

Generates a String representation of this object.

Overrides:

toString in class java.util.AbstractMap

Returns:

String representation of this ValueMap consistent with the tag-attribute style of markup elements. For example: a="x" b="y" c="z".