org.alfresco.util

Class PropertyMap

java.lang.Object

java.util.AbstractMap

java.util.HashMap

org.alfresco.util.PropertyMap

All Implemented Interfaces:

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

public class PropertyMap
extends java.util.HashMap

Property map helper class.

This class can be used as a short hand when a class of type Map<QName, Serializable> is required.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry, java.util.AbstractMap.SimpleImmutableEntry

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map	EMPTY_MAP A static empty map to us when having to deal with nulls

Constructor Summary

Constructors

Constructor and Description
PropertyMap()
PropertyMap(int initialCapacity)
PropertyMap(int initialCapacity, float loadFactor)

Method Summary

Methods

Modifier and Type	Method and Description
static java.util.Map	getAddedProperties(java.util.Map before, java.util.Map after) Utility method to get properties which were added as part of a change.
static org.alfresco.util.Pair	getBeforeAndAfterMapsForChanges(java.util.Map before, java.util.Map after) Utility method to remove unchanged entries from each map.
static java.util.Map	getChangedProperties(java.util.Map before, java.util.Map after) Utility method to get properties which were changed (but not added or removed) as part of a change.
static java.util.Map	getRemovedProperties(java.util.Map before, java.util.Map after) Utility method to get properties which were removed as part of a change.
static java.util.Map	getUnchangedProperties(java.util.Map before, java.util.Map after) Utility method to get properties which were unchanged as part of a change.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

EMPTY_MAP

public static final java.util.Map EMPTY_MAP

A static empty map to us when having to deal with nulls

Constructor Detail

PropertyMap

public PropertyMap(int initialCapacity,
           float loadFactor)

See Also:

HashMap.HashMap(int, float)

PropertyMap

public PropertyMap(int initialCapacity)

See Also:

HashMap.HashMap(int)

PropertyMap

public PropertyMap()

See Also:

HashMap.HashMap()

Method Detail

getBeforeAndAfterMapsForChanges

public static org.alfresco.util.Pair getBeforeAndAfterMapsForChanges(java.util.Map before,
                                                     java.util.Map after)

Utility method to remove unchanged entries from each map.

Parameters:

before - the properties before (may be null)

after - the properties after (may be null)

Returns:

Return a map of values that changed from before to after. The before value is first and the after value is second.

Since:

3.2

getAddedProperties

public static java.util.Map getAddedProperties(java.util.Map before,
                               java.util.Map after)

Utility method to get properties which were added as part of a change.

Parameters:

before - the properties before (may be null).

after - the properties after (may be null).

Returns:

a map of values that were added along with their new values.

Since:

Odin

getRemovedProperties

public static java.util.Map getRemovedProperties(java.util.Map before,
                                 java.util.Map after)

Utility method to get properties which were removed as part of a change.

Parameters:

before - the properties before (may be null).

after - the properties after (may be null).

Returns:

a map of values that were removed along with their old values.

Since:

Odin

getChangedProperties

public static java.util.Map getChangedProperties(java.util.Map before,
                                 java.util.Map after)

Utility method to get properties which were changed (but not added or removed) as part of a change.

Parameters:

before - the properties before (may be null).

after - the properties after (may be null).

Returns:

a map of values that were changed along with their new values.

Since:

Odin

getUnchangedProperties

public static java.util.Map getUnchangedProperties(java.util.Map before,
                                   java.util.Map after)

Utility method to get properties which were unchanged as part of a change.

Parameters:

before - the properties before (may be null).

after - the properties after (may be null).

Returns:

a map of values that were unchanged along with their values.

Since:

Odin