java.lang.Object
- org.apache.wicket.util.value.CopyOnWriteValueMap

All Implemented Interfaces:

Serializable, Map<String,Object>, IValueMap
```
public class CopyOnWriteValueMap
extends Object
implements IValueMap, Serializable
```
An implementation of IValueMap that makes a copy when a caller tries to change an immutable Map. That is, the Map may or may not be immutable, but if it is, a copy is made.

Since:

1.2.6

Author:

Johan Compagner, Doug Donohoe

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors
Constructor Description

CopyOnWriteValueMap(IValueMap wrapped)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<String,Object>>`	`entrySet()`
`boolean`	`equals(Object o)`
`Object`	`get(Object key)`
`Boolean`	`getAsBoolean(String key)`	Retrieves a `Boolean` value by key.
`boolean`	`getAsBoolean(String key, boolean defaultValue)`	Retrieves a `boolean` value by key.
`Double`	`getAsDouble(String key)`	Retrieves a `Double` value by key.
`double`	`getAsDouble(String key, double defaultValue)`	Retrieves a `double` value by key.
`Duration`	`getAsDuration(String key)`	Retrieves a `Duration` value by key.
`Duration`	`getAsDuration(String key, Duration defaultValue)`	Retrieves a `Duration` value by key.
`<T extends Enum<T>> T`	`getAsEnum(String key, Class<T> eClass)`	Retrieves an `Enum` value by key.
`<T extends Enum<T>> T`	`getAsEnum(String key, Class<T> eClass, T defaultValue)`	Retrieves an `Enum` value by key.
`<T extends Enum<T>> T`	`getAsEnum(String key, T defaultValue)`	Retrieves an `Enum` value by key.
`Instant`	`getAsInstant(String key)`	Retrieves a `Time` value by key.
`Integer`	`getAsInteger(String key)`	Retrieves an `Integer` value by key.
`int`	`getAsInteger(String key, int defaultValue)`	Retrieves an `integer` value by key.
`Long`	`getAsLong(String key)`	Retrieves a `Long` value by key.
`long`	`getAsLong(String key, long defaultValue)`	Retrieves a `long` value by key.
`Instant`	`getAsTime(String key, Instant defaultValue)`	Retrieves a `Time` value by key.
`boolean`	`getBoolean(String key)`	Retrieves a `boolean` value by key.
`CharSequence`	`getCharSequence(String key)`	Retrieves a `CharSequence` by key.
`double`	`getDouble(String key)`	Retrieves a `double` value by key.
`double`	`getDouble(String key, double defaultValue)`	Retrieves a `double` value by key, using a default value if not found.
`Duration`	`getDuration(String key)`	Retrieves a `Duration` by key.
`Instant`	`getInstant(String key)`	Retrieves a `Instant` object by key.
`int`	`getInt(String key)`	Retrieves an `int` value by key.
`int`	`getInt(String key, int defaultValue)`	Retrieves an `int` value by key, using a default value if not found.
`String`	`getKey(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(String key)`	Retrieves a `long` value by key.
`long`	`getLong(String key, long defaultValue)`	Retrieves a `long` value by key, using a default value if not found.
`String`	`getString(String key)`	Retrieves a `String` by key.
`String`	`getString(String key, String defaultValue)`	Retrieves a `String` by key, using a default value if not found.
`String[]`	`getStringArray(String key)`	Retrieves a `String` array by key.
`StringValue`	`getStringValue(String key)`	Retrieves a `StringValue` object by key.
`int`	`hashCode()`
`boolean`	`isEmpty()`
`boolean`	`isImmutable()`	Returns whether or not this `IValueMap` is immutable.
`Set<String>`	`keySet()`
`IValueMap`	`makeImmutable()`	Makes this `IValueMap` immutable by changing the underlying map representation to a `Collections.unmodifiableMap`.
`Object`	`put(String key, Object value)`
`void`	`putAll(Map<? extends String,?> map)`
`Object`	`remove(Object key)`
`int`	`size()`
`Collection<Object>`	`values()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - CopyOnWriteValueMap
```
public CopyOnWriteValueMap(IValueMap wrapped)
```
    Constructor.
    
    Parameters:
    
    wrapped - the wrapped IValueMap
- Method Detail
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Map<String,Object>
  - containsKey
```
public boolean containsKey(Object key)
```
    Specified by:
    
    containsKey in interface Map<String,Object>
  - containsValue
```
public boolean containsValue(Object value)
```
    Specified by:
    
    containsValue in interface Map<String,Object>
  - entrySet
```
public Set<Map.Entry<String,Object>> entrySet()
```
    Specified by:
    
    entrySet in interface Map<String,Object>
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Map<String,Object>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Map<String,Object>
    
    Overrides:
    
    hashCode in class Object
  - get
```
public Object get(Object key)
```
    Specified by:
    
    get in interface Map<String,Object>
  - getBoolean
```
public boolean getBoolean(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
  - getCharSequence
```
public CharSequence getCharSequence(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
  - getDouble
```
public double getDouble(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
  - getDouble
```
public double getDouble(String key,
                        double defaultValue)
```
    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
  - getDuration
```
public Duration getDuration(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
  - getInt
```
public int getInt(String key,
                  int defaultValue)
```
    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
  - getInt
```
public int getInt(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
  - getKey
```
public String getKey(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
  - getLong
```
public long getLong(String key,
                    long defaultValue)
```
    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
  - getLong
```
public long getLong(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
  - getString
```
public String getString(String key,
                        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
  - getString
```
public String getString(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
  - getStringArray
```
public String[] getStringArray(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
  - getStringValue
```
public StringValue getStringValue(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
  - getInstant
```
public Instant getInstant(String key)
                   throws StringValueConversionException
```
    Description copied from interface: IValueMap
    
    Retrieves a Instant object by key.
    
    Specified by:
    
    getInstant in interface IValueMap
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the Instant object
    
    Throws:
    
    StringValueConversionException
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Map<String,Object>
  - isImmutable
```
public 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
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Map<String,Object>
  - makeImmutable
```
public 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
  - put
```
public Object put(String key,
                  Object value)
```
    Specified by:
    
    put in interface Map<String,Object>
  - putAll
```
public void putAll(Map<? extends String,?> map)
```
    Specified by:
    
    putAll in interface Map<String,Object>
  - remove
```
public Object remove(Object key)
```
    Specified by:
    
    remove in interface Map<String,Object>
  - size
```
public int size()
```
    Specified by:
    
    size in interface Map<String,Object>
  - values
```
public Collection<Object> values()
```
    Specified by:
    
    values in interface Map<String,Object>
  - getAsBoolean
```
public Boolean getAsBoolean(String key)
```
    Description copied from interface: IValueMap
    
    Retrieves a Boolean value by key.
    
    Specified by:
    
    getAsBoolean in interface IValueMap
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value or null if value is not a valid boolean or no value is in this IValueMap
  - getAsBoolean
```
public boolean getAsBoolean(String key,
                            boolean defaultValue)
```
    Description copied from interface: IValueMap
    
    Retrieves a boolean value by key.
    
    Specified by:
    
    getAsBoolean in interface IValueMap
    
    Parameters:
    
    key - the key
    
    defaultValue - the default to return
    
    Returns:
    
    the value or defaultValue if value is not a valid boolean or no value is in this IValueMap
  - getAsInteger
```
public Integer getAsInteger(String key)
```
    Description copied from interface: IValueMap
    
    Retrieves an Integer value by key.
    
    Specified by:
    
    getAsInteger in interface IValueMap
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value or null if value is not a valid integer or no value is in this IValueMap
  - getAsInteger
```
public int getAsInteger(String key,
                        int defaultValue)
```
    Description copied from interface: IValueMap
    
    Retrieves an integer value by key.
    
    Specified by:
    
    getAsInteger in interface IValueMap
    
    Parameters:
    
    key - the key
    
    defaultValue - the default to return
    
    Returns:
    
    the value or defaultValue if value is not a valid integer or no value is in this IValueMap
  - getAsLong
```
public Long getAsLong(String key)
```
    Description copied from interface: IValueMap
    
    Retrieves a Long value by key.
    
    Specified by:
    
    getAsLong in interface IValueMap
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value or null if value is not a valid long or no value is in this IValueMap
  - getAsLong
```
public long getAsLong(String key,
                      long defaultValue)
```
    Description copied from interface: IValueMap
    
    Retrieves a long value by key.
    
    Specified by:
    
    getAsLong in interface IValueMap
    
    Parameters:
    
    key - the key
    
    defaultValue - the default to return
    
    Returns:
    
    the value or defaultValue if value is not a valid long or no value is in this IValueMap
  - getAsDouble
```
public Double getAsDouble(String key)
```
    Description copied from interface: IValueMap
    
    Retrieves a Double value by key.
    
    Specified by:
    
    getAsDouble in interface IValueMap
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value or null if value is not a valid double or no value is in this IValueMap
  - getAsDouble
```
public double getAsDouble(String key,
                          double defaultValue)
```
    Description copied from interface: IValueMap
    
    Retrieves a double value by key.
    
    Specified by:
    
    getAsDouble in interface IValueMap
    
    Parameters:
    
    key - the key
    
    defaultValue - the default to return
    
    Returns:
    
    the value or defaultValue if value is not a valid double or no value is in this IValueMap
  - getAsDuration
```
public Duration getAsDuration(String key)
```
    Description copied from interface: IValueMap
    
    Retrieves a Duration value by key.
    
    Specified by:
    
    getAsDuration in interface IValueMap
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value or null if value is not a valid Duration or no value is in this IValueMap
  - getAsDuration
```
public Duration getAsDuration(String key,
                              Duration defaultValue)
```
    Description copied from interface: IValueMap
    
    Retrieves a Duration value by key.
    
    Specified by:
    
    getAsDuration in interface IValueMap
    
    Parameters:
    
    key - the key
    
    defaultValue - the default to return
    
    Returns:
    
    the value or defaultValue if value is not a valid Duration or no value is in this IValueMap
  - getAsInstant
```
public Instant getAsInstant(String key)
```
    Description copied from interface: IValueMap
    
    Retrieves a Time value by key.
    
    Specified by:
    
    getAsInstant in interface IValueMap
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value or null if value is not a valid Time or no value is in this IValueMap
  - getAsTime
```
public Instant getAsTime(String key,
                         Instant defaultValue)
```
    Description copied from interface: IValueMap
    
    Retrieves a Time value by key.
    
    Specified by:
    
    getAsTime in interface IValueMap
    
    Parameters:
    
    key - the key
    
    defaultValue - the default to return
    
    Returns:
    
    the value or defaultValue if value is not a valid Time or no value is in this IValueMap
  - getAsEnum
```
public <T extends Enum<T>> T getAsEnum(String key,
                                       Class<T> eClass)
```
    Description copied from interface: IValueMap
    
    Retrieves an Enum value by key.
    
    Specified by:
    
    getAsEnum in interface IValueMap
    
    Type Parameters:
    
    T - type of enum
    
    Parameters:
    
    key - the key
    
    eClass - the enumeration class
    
    Returns:
    
    the value or null if value is not a valid value of the Enumeration or no value is in this IValueMap
  - getAsEnum
```
public <T extends Enum<T>> T getAsEnum(String key,
                                       T defaultValue)
```
    Description copied from interface: IValueMap
    
    Retrieves an Enum value by key.
    
    Specified by:
    
    getAsEnum in interface IValueMap
    
    Type Parameters:
    
    T - type of enum
    
    Parameters:
    
    key - the key
    
    defaultValue - the default value from the Enumeration (cannot be null)
    
    Returns:
    
    the value or defaultValue if value is not a valid value of the Enumeration or no value is in this IValueMap
  - getAsEnum
```
public <T extends Enum<T>> T getAsEnum(String key,
                                       Class<T> eClass,
                                       T defaultValue)
```
    Description copied from interface: IValueMap
    
    Retrieves an Enum value by key.
    
    Specified by:
    
    getAsEnum in interface IValueMap
    
    Type Parameters:
    
    T - type of enum
    
    Parameters:
    
    key - the key
    
    eClass - the enumeration class
    
    defaultValue - the default value from the Enumeration (may be null)
    
    Returns:
    
    the value or defaultValue if value is not a valid value of the Enumeration or no value is in this IValueMap

Class CopyOnWriteValueMap

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

CopyOnWriteValueMap

Method Detail

clear

containsKey

containsValue

entrySet

equals

hashCode

get

getBoolean

getCharSequence

getDouble

getDouble

getDuration

getInt

getInt

getKey

getLong

getLong

getString

getString

getStringArray

getStringValue

getInstant

isEmpty

isImmutable

keySet

makeImmutable

put

putAll

remove

size

values

getAsBoolean

getAsBoolean

getAsInteger

getAsInteger

getAsLong

getAsLong

getAsDouble

getAsDouble

getAsDuration

getAsDuration

getAsInstant

getAsTime

getAsEnum

getAsEnum

getAsEnum