DefaultValueMap (JMinor Framework API 0.12.5-SNAPSHOT)

java.lang.Object
- org.jminor.common.db.valuemap.DefaultValueMap<K,V>

Type Parameters:

K - the key type

V - the value type

All Implemented Interfaces:

ValueCollectionProvider<V>, ValueMap<K,V>, ValueProvider<K,V>
```
public class DefaultValueMap<K,V>
extends java.lang.Object
implements ValueMap<K,V>
```
A default ValueMap implementation. Note that this class is not thread safe.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultValueMap.DefaultValidator<K,V extends ValueMap<K,?>>` A default value map validator implementation, which performs basic null validation.

Nested classes/interfaces inherited from interface org.jminor.common.db.valuemap.ValueMap
ValueMap.Validator<K,V extends ValueMap<K,?>>

Constructor Summary

Constructors
Modifier	Constructor and Description
	`DefaultValueMap()` Instantiates a new empty instance
`protected`	`DefaultValueMap(java.util.Map<K,V> values, java.util.Map<K,V> originalValues)` Instantiates a new instance using the given maps for the values and original values respectively.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValueListener(EventDataListener<ValueChange<K,V>> valueListener)` Adds a listener notified each time a value changes Adding the same listener multiple times has no effect.
`void`	`clear()` Silently removes all values from this map, as in, removes the values without firing value change events
`boolean`	`containsKey(K key)` Returns true if this ValueMap contains a value for the given key, that value can be null.
`protected V`	`copy(V value)` Returns a deep copy of the given value, immutable values are simply returned.
`boolean`	`equals(java.lang.Object obj)` Two DefaultValueMap objects are equal if they contain the same number of values and all their values are equal.
`V`	`get(K key)` Retrieves the value mapped to the given key
`java.lang.String`	`getAsString(K key)` Retrieves a string representation of the value mapped to the given key, an empty string is returned in case of null values or if key is not found.
`ValueMap<K,V>`	`getCopy()`
`StateObserver`	`getModifiedObserver()`
`V`	`getOriginal(K key)` Returns the original value associated with the given key or the current value if it has not been modified.
`ValueMap<K,V>`	`getOriginalCopy()`
`EventObserver<ValueChange<K,V>>`	`getValueObserver()` Returns an EventObserver notified each time a value changes, with a `ValueChange` argument.
`protected void`	`handleClear()` Called after the value map has been cleared.
`protected void`	`handlePut(K key, V value, V previousValue, boolean initialization)` Called after a value has been put.
`protected void`	`handleRemove(K key, V value)` Called after a value has been removed from this map.
`protected void`	`handleValueChangedEventInitialized()` Called after the valueChangeEvent has been initialized, via the first call to `getValueChangedEvent()`
`int`	`hashCode()`
`boolean`	`isModified()`
`boolean`	`isModified(K key)` Returns true if the value associated with the given key has been modified..
`boolean`	`isNotNull(K key)` Returns true if a this ValueMap contains a non-null value mapped to the given key
`boolean`	`isNull(K key)` Returns true if a null value is mapped to the given key or the key is not found.
`java.util.Set<K>`	`keySet()`
`ValueMap<K,V>`	`newInstance()`
`protected void`	`notifyValueChange(K key, V currentValue, V previousValue, boolean initialization)`
`java.util.Set<K>`	`originalKeySet()`
`V`	`put(K key, V value)` Maps the given value to the given key, returning the old value if any.
`V`	`remove(K key)` Removes the given key and value from this value map along with the original value if any.
`protected void`	`removeOriginalValue(K key)`
`void`	`removeValueListener(EventDataListener valueListener)` Removes the given value listener if it has been registered with this value map.
`void`	`revert(K key)` Reverts the value associated with the given key to its original value.
`void`	`revertAll()` Reverts all value modifications that have been made.
`void`	`save(K key)` Saves the value associated with the given key, that is, removes the original value.
`void`	`saveAll()` Saves all the value modifications that have been made.
`void`	`setAs(ValueMap<K,V> sourceMap)` After a call to this method this ValueMap contains the same values and original values as the source map.
`protected void`	`setOriginalValue(K key, V previousValue)`
`int`	`size()`
`java.util.Collection<V>`	`values()` Retrieves the values associated with this value provider.

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

- Constructor Detail
  - DefaultValueMap
```
public DefaultValueMap()
```
    Instantiates a new empty instance
  - DefaultValueMap
```
protected DefaultValueMap(java.util.Map<K,V> values,
                          java.util.Map<K,V> originalValues)
```
    Instantiates a new instance using the given maps for the values and original values respectively. Note that the given map instances are used internally, modifying the contents of those maps outside this DefaultValueMap instance will result in undefined behaviour, to put things politely.
    
    Parameters:
    
    values - the values
    
    originalValues - the originalValues
- Method Detail
  - isNull
```
public boolean isNull(K key)
```
    Returns true if a null value is mapped to the given key or the key is not found.
    
    Specified by:
    
    isNull in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if the value mapped to the given key is null
  - isNotNull
```
public boolean isNotNull(K key)
```
    Returns true if a this ValueMap contains a non-null value mapped to the given key
    
    Specified by:
    
    isNotNull in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if the value mapped to the given key is not null
  - put
```
public V put(K key,
             V value)
```
    Maps the given value to the given key, returning the old value if any.
    
    Specified by:
    
    put in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key
    
    value - the value
    
    Returns:
    
    the previous value mapped to the given key
  - get
```
public V get(K key)
```
    Retrieves the value mapped to the given key
    
    Specified by:
    
    get in interface ValueProvider<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value mapped to the given key, null if no such mapping exists
  - getAsString
```
public java.lang.String getAsString(K key)
```
    Retrieves a string representation of the value mapped to the given key, an empty string is returned in case of null values or if key is not found.
    
    Specified by:
    
    getAsString in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the value mapped to the given key as a string, an empty string if no such mapping exists
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Two DefaultValueMap objects are equal if they contain the same number of values and all their values are equal.
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - containsKey
```
public final boolean containsKey(K key)
```
    Returns true if this ValueMap contains a value for the given key, that value can be null.
    
    Specified by:
    
    containsKey in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if a value is mapped to this key
  - remove
```
public final V remove(K key)
```
    Removes the given key and value from this value map along with the original value if any. If no value is mapped to the given key, this method has no effect.
    
    Specified by:
    
    remove in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key to remove
    
    Returns:
    
    the value that was removed, null if no value was found
  - clear
```
public final void clear()
```
    Silently removes all values from this map, as in, removes the values without firing value change events
    
    Specified by:
    
    clear in interface ValueMap<K,V>
  - size
```
public final int size()
```
    Specified by:
    
    size in interface ValueMap<K,V>
    
    Returns:
    
    the number of values in this map
  - keySet
```
public final java.util.Set<K> keySet()
```
    Specified by:
    
    keySet in interface ValueMap<K,V>
    
    Returns:
    
    an unmodifiable view of the keys mapping the values in this ValueMap
  - originalKeySet
```
public final java.util.Set<K> originalKeySet()
```
    Specified by:
    
    originalKeySet in interface ValueMap<K,V>
    
    Returns:
    
    an unmodifiable view of the keys mapping the original values in this ValueMap
  - values
```
public final java.util.Collection<V> values()
```
    Retrieves the values associated with this value provider.
    
    Specified by:
    
    values in interface ValueCollectionProvider<V>
    
    Returns:
    
    a collection containing the values provided by this value provider
  - getOriginal
```
public final V getOriginal(K key)
```
    Returns the original value associated with the given key or the current value if it has not been modified.
    
    Specified by:
    
    getOriginal in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key for which to retrieve the original value
    
    Returns:
    
    the original value
  - isModified
```
public boolean isModified()
```
    Specified by:
    
    isModified in interface ValueMap<K,V>
    
    Returns:
    
    true if one or more values have been modified.
  - newInstance
```
public ValueMap<K,V> newInstance()
```
    Specified by:
    
    newInstance in interface ValueMap<K,V>
    
    Returns:
    
    a new ValueMap instance compatible with this instance
  - getCopy
```
public final ValueMap<K,V> getCopy()
```
    Specified by:
    
    getCopy in interface ValueMap<K,V>
    
    Returns:
    
    a deep copy of this value map
  - setAs
```
public final void setAs(ValueMap<K,V> sourceMap)
```
    After a call to this method this ValueMap contains the same values and original values as the source map. A null argument to this method clears the destination map of all values and original values. Value change events for affected keys are fired after all values have been set, in no particular order.
    
    Specified by:
    
    setAs in interface ValueMap<K,V>
    
    Parameters:
    
    sourceMap - the map to copy or null for clearing the destination map
  - isModified
```
public final boolean isModified(K key)
```
    Returns true if the value associated with the given key has been modified..
    
    Specified by:
    
    isModified in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true if the value has changed
  - revert
```
public final void revert(K key)
```
    Reverts the value associated with the given key to its original value. If the value has not been modified or the key is not found then calling this method has no effect.
    
    Specified by:
    
    revert in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key for which to revert the value
  - revertAll
```
public final void revertAll()
```
    Reverts all value modifications that have been made. This value map will be unmodified after a call to this method. If no modifications have been made then calling this method has no effect.
    
    Specified by:
    
    revertAll in interface ValueMap<K,V>
  - save
```
public final void save(K key)
```
    Saves the value associated with the given key, that is, removes the original value. If no original value exists calling this method has no effect.
    
    Specified by:
    
    save in interface ValueMap<K,V>
    
    Parameters:
    
    key - the key for which to save the value
  - saveAll
```
public final void saveAll()
```
    Saves all the value modifications that have been made. This value map will be unmodified after a call to this method.
    
    Specified by:
    
    saveAll in interface ValueMap<K,V>
  - getOriginalCopy
```
public final ValueMap<K,V> getOriginalCopy()
```
    Specified by:
    
    getOriginalCopy in interface ValueMap<K,V>
    
    Returns:
    
    a deep copy of this value map in its original state
  - addValueListener
```
public final void addValueListener(EventDataListener<ValueChange<K,V>> valueListener)
```
    Adds a listener notified each time a value changes Adding the same listener multiple times has no effect.
    
    Specified by:
    
    addValueListener in interface ValueMap<K,V>
    
    Parameters:
    
    valueListener - the listener
    
    See Also:
    
    ValueChange
  - removeValueListener
```
public final void removeValueListener(EventDataListener valueListener)
```
    Removes the given value listener if it has been registered with this value map.
    
    Specified by:
    
    removeValueListener in interface ValueMap<K,V>
    
    Parameters:
    
    valueListener - the listener to remove
  - getModifiedObserver
```
public final StateObserver getModifiedObserver()
```
    Specified by:
    
    getModifiedObserver in interface ValueMap<K,V>
    
    Returns:
    
    a StateObserver indicating if one or more values in this value map have been modified.
  - getValueObserver
```
public final EventObserver<ValueChange<K,V>> getValueObserver()
```
    Returns an EventObserver notified each time a value changes, with a ValueChange argument.
    
    Specified by:
    
    getValueObserver in interface ValueMap<K,V>
    
    Returns:
    
    an EventObserver notified when a value changes.
    
    See Also:
    
    ValueChange
  - notifyValueChange
```
protected final void notifyValueChange(K key,
                                       V currentValue,
                                       V previousValue,
                                       boolean initialization)
```
  - setOriginalValue
```
protected final void setOriginalValue(K key,
                                      V previousValue)
```
  - removeOriginalValue
```
protected final void removeOriginalValue(K key)
```
  - copy
```
protected V copy(V value)
```
    Returns a deep copy of the given value, immutable values are simply returned.
    
    Parameters:
    
    value - the value to copy
    
    Returns:
    
    a deep copy of the given value, or the same instance in case the value is immutable
  - handlePut
```
protected void handlePut(K key,
                         V value,
                         V previousValue,
                         boolean initialization)
```
    Called after a value has been put. This base implementation does nothing.
    
    Parameters:
    
    key - the key
    
    value - the value
    
    previousValue - the previous value
    
    initialization - true if the value was being initialized
  - handleRemove
```
protected void handleRemove(K key,
                            V value)
```
    Called after a value has been removed from this map. This base implementation does nothing.
    
    Parameters:
    
    key - the key
    
    value - the value that was removed
  - handleClear
```
protected void handleClear()
```
    Called after the value map has been cleared. This base implementation does nothing.
  - handleValueChangedEventInitialized
```
protected void handleValueChangedEventInitialized()
```
    Called after the valueChangeEvent has been initialized, via the first call to getValueChangedEvent()

Class DefaultValueMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface org.jminor.common.db.valuemap.ValueMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultValueMap

DefaultValueMap

Method Detail

isNull

isNotNull

put

get

getAsString

equals

hashCode

containsKey

remove

clear

size

keySet

originalKeySet

values

getOriginal

isModified

newInstance

getCopy

setAs

isModified

revert

revertAll

save

saveAll

getOriginalCopy

addValueListener

removeValueListener

getModifiedObserver

getValueObserver

notifyValueChange

setOriginalValue

removeOriginalValue

copy

handlePut

handleRemove

handleClear

handleValueChangedEventInitialized