ValueProtectingMap (Alfresco Repository)

java.lang.Object
- org.alfresco.util.ValueProtectingMap

All Implemented Interfaces:

java.io.Serializable, java.util.Map
```
public class ValueProtectingMap
extends java.lang.Object
implements java.util.Map, java.io.Serializable
```
A map that protects keys and values from accidental modification.
Use this map when keys or values need to be protected against client modification. For example, when a component pulls a map from a common resource it can wrap the map with this class to prevent any accidental modification of the shared resource.
Upon first write to this map , the underlying map will be copied (selectively cloned), the original map handle will be discarded and the copied map will be used. Note that the map copy process will also occur if any mutable value is in danger of being exposed to client modification. Therefore, methods that iterate and retrieve values will also trigger the copy if any values are mutable.

Since:

3.4.9, 4.0.1

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry

Field Summary

Fields
Modifier and Type	Field and Description
`static java.util.Set`	`DEFAULT_IMMUTABLE_CLASSES` Default immutable classes: String BigDecimal BigInteger Byte Double Float Integer Long Short Boolean Date Locale

Constructor Summary

Constructors
Constructor and Description
`ValueProtectingMap(java.util.Map protectedMap)` Construct providing a protected map and using only the `default immutable classes`
`ValueProtectingMap(java.util.Map protectedMap, java.util.Set immutableClasses)` Construct providing a protected map, complementing the set of `default immutable classes`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()`
`static java.util.Map`	`cloneMap(java.util.Map map, java.util.Set immutableClasses)` Utility method to clone a map, preserving immutable instances
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set`	`entrySet()`
`boolean`	`equals(java.lang.Object obj)`
`java.io.Serializable`	`get(java.lang.Object key)`
`int`	`hashCode()`
`boolean`	`isEmpty()`
`java.util.Set`	`keySet()`
`static boolean`	`mustProtectValue(java.io.Serializable value, java.util.Set immutableClasses)` Utility method to check if values need to be cloned or not
`static java.io.Serializable`	`protectValue(java.io.Serializable value, java.util.Set immutableClasses)` Protect a specific value if it is considered mutable
`java.io.Serializable`	`put(java.io.Serializable key, java.io.Serializable value)`
`void`	`putAll(java.util.Map m)`
`java.io.Serializable`	`remove(java.lang.Object key)`
`int`	`size()`
`java.lang.String`	`toString()`
`java.util.Collection`	`values()`

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

- Field Detail
  - DEFAULT_IMMUTABLE_CLASSES
```
public static final java.util.Set DEFAULT_IMMUTABLE_CLASSES
```
    Default immutable classes:
  - String
  - BigDecimal
  - BigInteger
  - Byte
  - Double
  - Float
  - Integer
  - Long
  - Short
  - Boolean
  - Date
  - Locale

Constructor Detail
- ValueProtectingMap
```
public ValueProtectingMap(java.util.Map protectedMap)
```
  Construct providing a protected map and using only the default immutable classes
  
  Parameters:
  protectedMap - the map to safeguard
- ValueProtectingMap
```
public ValueProtectingMap(java.util.Map protectedMap,
                  java.util.Set immutableClasses)
```
  Construct providing a protected map, complementing the set of default immutable classes
  
  Parameters:
  protectedMap - the map to safeguard
  immutableClasses - additional immutable classes over and above the default set (may be null

Method Detail
- protectValue
```
public static java.io.Serializable protectValue(java.io.Serializable value,
                                java.util.Set immutableClasses)
```
  Protect a specific value if it is considered mutable
  
  Parameters:
  value - the value to protect if it is mutable (may be null)
  immutableClasses - a set of classes that can be considered immutable over and above the default set
  
  Returns:
  a cloned instance (via serialization) or the instance itself, if immutable
- mustProtectValue
```
public static boolean mustProtectValue(java.io.Serializable value,
                       java.util.Set immutableClasses)
```
  Utility method to check if values need to be cloned or not
  
  Parameters:
  value - the value to check
  immutableClasses - a set of classes that can be considered immutable over and above the default set
  
  Returns:
  true if the value must NOT be given to the calling clients
- cloneMap
```
public static java.util.Map cloneMap(java.util.Map map,
                     java.util.Set immutableClasses)
```
  Utility method to clone a map, preserving immutable instances
  
  Parameters:
  map - the map to copy
  immutableClasses - a set of classes that can be considered immutable over and above the default set
- size
```
public int size()
```
  Specified by:
  
  size in interface java.util.Map
- isEmpty
```
public boolean isEmpty()
```
  Specified by:
  
  isEmpty in interface java.util.Map
- containsKey
```
public boolean containsKey(java.lang.Object key)
```
  Specified by:
  
  containsKey in interface java.util.Map
- containsValue
```
public boolean containsValue(java.lang.Object value)
```
  Specified by:
  
  containsValue in interface java.util.Map
- hashCode
```
public int hashCode()
```
  Specified by:
  
  hashCode in interface java.util.Map
  
  Overrides:
  
  hashCode in class java.lang.Object
- equals
```
public boolean equals(java.lang.Object obj)
```
  Specified by:
  
  equals in interface java.util.Map
  
  Overrides:
  
  equals in class java.lang.Object
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object
- get
```
public java.io.Serializable get(java.lang.Object key)
```
  Specified by:
  
  get in interface java.util.Map
- put
```
public java.io.Serializable put(java.io.Serializable key,
                       java.io.Serializable value)
```
  Specified by:
  
  put in interface java.util.Map
- remove
```
public java.io.Serializable remove(java.lang.Object key)
```
  Specified by:
  
  remove in interface java.util.Map
- putAll
```
public void putAll(java.util.Map m)
```
  Specified by:
  
  putAll in interface java.util.Map
- clear
```
public void clear()
```
  Specified by:
  
  clear in interface java.util.Map
- keySet
```
public java.util.Set keySet()
```
  Specified by:
  
  keySet in interface java.util.Map
- values
```
public java.util.Collection values()
```
  Specified by:
  
  values in interface java.util.Map
- entrySet
```
public java.util.Set entrySet()
```
  Specified by:
  
  entrySet in interface java.util.Map

Class ValueProtectingMap

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_IMMUTABLE_CLASSES

Constructor Detail

ValueProtectingMap

ValueProtectingMap

Method Detail

protectValue

mustProtectValue

cloneMap

size

isEmpty

containsKey

containsValue

hashCode

equals

toString

get

put

remove

putAll

clear

keySet

values

entrySet