Top Description Inners Fields Constructors Methods
groovy.util

public Class ObservableMap

extends Object
implements Map
Class Inheritance
All Implemented Interfaces
java.util.Map
Imports
groovy.lang.Closure, java.beans.PropertyChangeEvent, .PropertyChangeListener, .PropertyChangeSupport, java.util.ArrayList, .Collection, .Collections, .HashMap, .LinkedHashMap, .List, .Map, .Set

Map decorator that will trigger PropertyChangeEvents when a value changes.
An optional Closure may be specified and will work as a filter, if it returns true the property will trigger an event (if the value indeed changed), otherwise it won't. The Closure may receive 1 or 2 parameters, the single one being the value, the other one both the key and value, for example:
// skip all properties whose value is a closure
def map = new ObservableMap( {!(it instanceof Closure)} )

// skip all properties whose name matches a regex
def map = new ObservableMap( { name, value -> !(name =~ /[A-Z+]/) } )
The current implementation will trigger specialized events in the following scenarios, you need not register a different listener as those events extend from PropertyChangeEvent

Bound properties

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
public static class
public static class
public static class
public abstract static class
public static class
public static class

Field Summary

Modifier and TypeField and Description
public static final String
public static final String
private final Map<K, V>
private final PropertyChangeSupport
public static final String
private final Closure<V>

Constructor Summary

AccessConstructor and Description
public
public
public
ObservableMap(Map<K, V> delegate)

public
ObservableMap(Map<K, V> delegate, Closure<V> test)

Method Summary

Modifier and TypeMethod and Description
public void
public void
public void
clear()

Implements java.util.Map.clear.

Removes all of the mappings from this map (optional operation).
public boolean
containsKey(Object
key whose presence in this map is to be tested
key
)

Implements java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key.
public boolean
containsValue(Object
value whose presence in this map is to be tested
value
)

Implements java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value.
public Set<E>
entrySet()

Implements java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map.
public boolean
equals(Object
object to be compared for equality with this map
o
)

Overrides java.lang.Object.equals.

Implements java.util.Map.equals.

Compares the specified object with this map for equality.
protected void
protected void
protected void
protected void
protected void
protected void
protected void
firePropertyUpdatedEvent(Object key, Object oldValue, Object newValue)

protected void
fireSizeChangedEvent(int oldValue, int newValue)

public Object
get(Object
the key whose associated value is to be returned
key
)

Implements java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
public Map<K, V>
protected Map<K, V>
public PropertyChangeListener[]
public PropertyChangeListener[]
public int
protected Closure<V>
public int
hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.hashCode.

Returns the hash code value for this map.
public boolean
hasListeners(String propertyName)

public boolean
isEmpty()

Implements java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.
public Set<E>
keySet()

Implements java.util.Map.keySet.

Returns a Set view of the keys contained in this map.
public Object
put(Object
key with which the specified value is to be associated
key
,
Object
value to be associated with the specified key
value
)

Implements java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation).
public void
putAll(Map<K, V>
mappings to be stored in this map
map
)

Implements java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation).
public Object
remove(Object
key whose mapping is to be removed from the map
key
)

Implements java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation).
public void
public void
public int
size()

Implements java.util.Map.size.

Returns the number of key-value mappings in this map.
public Collection<E>
values()

Implements java.util.Map.values.

Returns a Collection view of the values contained in this map.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

CLEARED_PROPERTYback to summary
public static final String CLEARED_PROPERTY
CONTENT_PROPERTYback to summary
public static final String CONTENT_PROPERTY
delegateback to summary
private final Map<K, V> delegate
pcsback to summary
private final PropertyChangeSupport pcs
SIZE_PROPERTYback to summary
public static final String SIZE_PROPERTY
testback to summary
private final Closure<V> test

Constructor Detail

ObservableMapback to summary
public ObservableMap()
ObservableMapback to summary
public ObservableMap(Closure<V> test)
ObservableMapback to summary
public ObservableMap(Map<K, V> delegate)
ObservableMapback to summary
public ObservableMap(Map<K, V> delegate, Closure<V> test)

Method Detail

addPropertyChangeListenerback to summary
public void addPropertyChangeListener(PropertyChangeListener listener)
addPropertyChangeListenerback to summary
public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)
clearback to summary
public void clear()

Implements java.util.Map.clear.

Doc from java.util.Map.clear.

Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

containsKeyback to summary
public boolean containsKey(Object key)

Implements java.util.Map.containsKey.

Doc from java.util.Map.containsKey.

Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that Objects.equals(key, k). (There can be at most one such mapping.)

Parameters
key:Object

key whose presence in this map is to be tested

Returns:boolean

true if this map contains a mapping for the specified key

containsValueback to summary
public boolean containsValue(Object value)

Implements java.util.Map.containsValue.

Doc from java.util.Map.containsValue.

Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that Objects.equals(value, v). This operation will probably require time linear in the map size for most implementations of the Map interface.

Parameters
value:Object

value whose presence in this map is to be tested

Returns:boolean

true if this map maps one or more keys to the specified value

entrySetback to summary
public Set<E> entrySet()

Implements java.util.Map.entrySet.

Doc from java.util.Map.entrySet.

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Set<E>

a set view of the mappings contained in this map

equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements java.util.Map.equals.

Doc from java.util.Map.equals.

Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.

Parameters
o:Object

object to be compared for equality with this map

Returns:boolean

true if the specified object is equal to this map

fireMultiPropertyEventback to summary
protected void fireMultiPropertyEvent(List<ObservableMap.PropertyEvent> events)
fireMultiPropertyEventback to summary
protected void fireMultiPropertyEvent(ObservableMap.PropertyEvent[] events)
firePropertyAddedEventback to summary
protected void firePropertyAddedEvent(Object key, Object value)
firePropertyClearedEventback to summary
protected void firePropertyClearedEvent(Map<K, V> values)
firePropertyEventback to summary
protected void firePropertyEvent(ObservableMap.PropertyEvent event)
firePropertyRemovedEventback to summary
protected void firePropertyRemovedEvent(Object key, Object value)
firePropertyUpdatedEventback to summary
protected void firePropertyUpdatedEvent(Object key, Object oldValue, Object newValue)
fireSizeChangedEventback to summary
protected void fireSizeChangedEvent(int oldValue, int newValue)
getback to summary
public Object get(Object key)

Implements java.util.Map.get.

Doc from java.util.Map.get.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

More formally, if this map contains a mapping from a key k to a value v such that Objects.equals(key, k), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters
key:Object

the key whose associated value is to be returned

Returns:Object

the value to which the specified key is mapped, or null if this map contains no mapping for the key

getContentback to summary
public Map<K, V> getContent()
getMapDelegateback to summary
protected Map<K, V> getMapDelegate()
getPropertyChangeListenersback to summary
public PropertyChangeListener[] getPropertyChangeListeners()
getPropertyChangeListenersback to summary
public PropertyChangeListener[] getPropertyChangeListeners(String propertyName)
getSizeback to summary
public int getSize()
getTestback to summary
protected Closure<V> getTest()
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Implements java.util.Map.hashCode.

Doc from java.util.Map.hashCode.

Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object#hashCode.

Returns:int

the hash code value for this map

hasListenersback to summary
public boolean hasListeners(String propertyName)
isEmptyback to summary
public boolean isEmpty()

Implements java.util.Map.isEmpty.

Doc from java.util.Map.isEmpty.

Returns true if this map contains no key-value mappings.

Returns:boolean

true if this map contains no key-value mappings

keySetback to summary
public Set<E> keySet()

Implements java.util.Map.keySet.

Doc from java.util.Map.keySet.

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Returns:Set<E>

a set view of the keys contained in this map

putback to summary
public Object put(Object key, Object value)

Implements java.util.Map.put.

Doc from java.util.Map.put.

Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)

Parameters
key:Object

key with which the specified value is to be associated

value:Object

value to be associated with the specified key

Returns:Object

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

putAllback to summary
public void putAll(Map<K, V> map)

Implements java.util.Map.putAll.

Doc from java.util.Map.putAll.

Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress. If the specified map has a defined encounter order, processing of its mappings generally occurs in that order.

Parameters
map:Map<K, V>

mappings to be stored in this map

removeback to summary
public Object remove(Object key)

Implements java.util.Map.remove.

Doc from java.util.Map.remove.

Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that Objects.equals(key, k), that mapping is removed. (The map can contain at most one such mapping.)

Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

The map will not contain a mapping for the specified key once the call returns.

Parameters
key:Object

key whose mapping is to be removed from the map

Returns:Object

the previous value associated with key, or null if there was no mapping for key.

removePropertyChangeListenerback to summary
public void removePropertyChangeListener(PropertyChangeListener listener)
removePropertyChangeListenerback to summary
public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)
sizeback to summary
public int size()

Implements java.util.Map.size.

Doc from java.util.Map.size.

Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:int

the number of key-value mappings in this map

valuesback to summary
public Collection<E> values()

Implements java.util.Map.values.

Doc from java.util.Map.values.

Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Returns:Collection<E>

a collection view of the values contained in this map

groovy.util back to summary

public final Enum ObservableMap.ChangeType

extends Enum<ObservableMap.ChangeType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final ObservableMap.ChangeType
public static final ObservableMap.ChangeType
public static final ObservableMap.ChangeType
public static final Object
public static final ObservableMap.ChangeType
public static final Object
public static final ObservableMap.ChangeType
public static final ObservableMap.ChangeType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static ObservableMap.ChangeType
resolve(int ordinal)

public static ObservableMap.ChangeType
public static ObservableMap.ChangeType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

ADDEDback to summary
public static final ObservableMap.ChangeType ADDED
CLEAREDback to summary
public static final ObservableMap.ChangeType CLEARED
MULTIback to summary
public static final ObservableMap.ChangeType MULTI
newValueback to summary
public static final Object newValue
NONEback to summary
public static final ObservableMap.ChangeType NONE
oldValueback to summary
public static final Object oldValue
REMOVEDback to summary
public static final ObservableMap.ChangeType REMOVED
UPDATEDback to summary
public static final ObservableMap.ChangeType UPDATED

Constructor Detail

ChangeTypeback to summary
private ChangeType()

Method Detail

resolveback to summary
public static ObservableMap.ChangeType resolve(int ordinal)
valueOfback to summary
public static ObservableMap.ChangeType valueOf(String name)
valuesback to summary
public static ObservableMap.ChangeType[] values()
groovy.util back to summary

public Class ObservableMap.MultiPropertyEvent

extends PropertyEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final ObservableMap.PropertyEvent[]
private final ObservableMap.PropertyEvent[]
public static final String
private static final long

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public ObservableMap.PropertyEvent[]
Inherited from groovy.util.ObservableMap.PropertyEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

EMPTY_PROPERTY_EVENTSback to summary
private static final ObservableMap.PropertyEvent[] EMPTY_PROPERTY_EVENTS
eventsback to summary
private final ObservableMap.PropertyEvent[] events
MULTI_PROPERTYback to summary
public static final String MULTI_PROPERTY
serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableMap.PropertyEvent.serialVersionUID.

Constructor Detail

MultiPropertyEventback to summary
public MultiPropertyEvent(Object source, ObservableMap.PropertyEvent[] events)

Method Detail

getEventsback to summary
public ObservableMap.PropertyEvent[] getEvents()
groovy.util back to summary

public Class ObservableMap.PropertyAddedEvent

extends PropertyEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public
PropertyAddedEvent(Object source, String propertyName, Object newValue)

Method Summary

Inherited from groovy.util.ObservableMap.PropertyEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableMap.PropertyEvent.serialVersionUID.

Constructor Detail

PropertyAddedEventback to summary
public PropertyAddedEvent(Object source, String propertyName, Object newValue)
groovy.util back to summary

public Class ObservableMap.PropertyClearedEvent

extends PropertyEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long
private Map<K, V>

Constructor Summary

AccessConstructor and Description
public
PropertyClearedEvent(Object source, Map<K, V> values)

Method Summary

Modifier and TypeMethod and Description
public Map<K, V>
Inherited from groovy.util.ObservableMap.PropertyEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableMap.PropertyEvent.serialVersionUID.

valuesback to summary
private Map<K, V> values

Constructor Detail

PropertyClearedEventback to summary
public PropertyClearedEvent(Object source, Map<K, V> values)

Method Detail

getValuesback to summary
public Map<K, V> getValues()
groovy.util back to summary

public abstract Class ObservableMap.PropertyEvent

extends PropertyChangeEvent
Class Inheritance
Known Direct Subclasses
groovy.util.ObservableMap.PropertyAddedEvent, groovy.util.ObservableMap.PropertyUpdatedEvent, groovy.util.ObservableMap.PropertyRemovedEvent, groovy.util.ObservableMap.PropertyClearedEvent, groovy.util.ObservableMap.MultiPropertyEvent

Field Summary

Modifier and TypeField and Description
private static final long
private ObservableMap.ChangeType

Constructor Summary

AccessConstructor and Description
public
PropertyEvent(Object source, String propertyName, Object oldValue, Object newValue, ObservableMap.ChangeType type)

Method Summary

Modifier and TypeMethod and Description
public ObservableMap.ChangeType
public int
public String
Inherited from java.beans.PropertyChangeEvent:
getNewValuegetOldValuegetPropagationIdgetPropertyNamesetPropagationIdtoString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides java.beans.PropertyChangeEvent.serialVersionUID.

typeback to summary
private ObservableMap.ChangeType type

Constructor Detail

PropertyEventback to summary
public PropertyEvent(Object source, String propertyName, Object oldValue, Object newValue, ObservableMap.ChangeType type)

Method Detail

getChangeTypeback to summary
public ObservableMap.ChangeType getChangeType()
getTypeback to summary
public int getType()
getTypeAsStringback to summary
public String getTypeAsString()
groovy.util back to summary

public Class ObservableMap.PropertyRemovedEvent

extends PropertyEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public
PropertyRemovedEvent(Object source, String propertyName, Object oldValue)

Method Summary

Inherited from groovy.util.ObservableMap.PropertyEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableMap.PropertyEvent.serialVersionUID.

Constructor Detail

PropertyRemovedEventback to summary
public PropertyRemovedEvent(Object source, String propertyName, Object oldValue)
groovy.util back to summary

public Class ObservableMap.PropertyUpdatedEvent

extends PropertyEvent
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long

Constructor Summary

AccessConstructor and Description
public
PropertyUpdatedEvent(Object source, String propertyName, Object oldValue, Object newValue)

Method Summary

Inherited from groovy.util.ObservableMap.PropertyEvent:
getChangeTypegetTypegetTypeAsString

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides groovy.util.ObservableMap.PropertyEvent.serialVersionUID.

Constructor Detail

PropertyUpdatedEventback to summary
public PropertyUpdatedEvent(Object source, String propertyName, Object oldValue, Object newValue)