org.fuin.utils4j
Class ChangeTrackingMap

java.lang.Object
  org.fuin.utils4j.ChangeTrackingMap

All Implemented Interfaces:

java.util.Map

public class ChangeTrackingMap
extends java.lang.Object
implements java.util.Map

A wrapper for maps that keeps track of all changes made to the map since construction. Only adding, replacing or deleting elements is tracked (not changes inside the objects). It's also possible to revert all changes.

Nested Class Summary

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

java.util.Map.Entry<K,V>

Constructor Summary

ChangeTrackingMap(java.util.Map map)
Constructor with covered map.

Method Summary

void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set	entrySet()
java.lang.Object	get(java.lang.Object key)
java.util.Map	getAdded() Returns added elements.
java.util.Map	getChanged() Returns changed elements.
java.util.Map	getRemoved() Returns removed elements.
boolean	isChanged() Returns if the list has changed.
boolean	isEmpty()
java.util.Set	keySet()
java.lang.Object	put(java.lang.Object key, java.lang.Object newValue)
void	putAll(java.util.Map newMap)
java.lang.Object	remove(java.lang.Object key)
void	revert() Roll back all changes made since construction.
int	size()
java.lang.String	toString()
java.util.Collection	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

ChangeTrackingMap

public ChangeTrackingMap(java.util.Map map)

Constructor with covered map.

Parameters:

map - Wrapped map - Be aware that this map will be changed by this class. There is no internal copy of the map - The reference itself is used.

Method Detail

isChanged

public final boolean isChanged()

Returns if the list has changed.

Returns:

If elements have been added or deleted true else false.

getRemoved

public final java.util.Map getRemoved()

Returns removed elements.

Returns:

Elements that have been deleted since construction of this instance.

getChanged

public final java.util.Map getChanged()

Returns changed elements.

Returns:

Elements that have been changed since construction of this instance.

revert

public final void revert()

Roll back all changes made since construction.

getAdded

public final java.util.Map getAdded()

Returns added elements.

Returns:

Elements that have been added since construction of this instance.

clear

public final void clear()

Specified by:

clear in interface java.util.Map

containsKey

public final boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map

containsValue

public final boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map

entrySet

public final java.util.Set entrySet()

Specified by:

entrySet in interface java.util.Map

get

public final java.lang.Object get(java.lang.Object key)

Specified by:

get in interface java.util.Map

isEmpty

public final boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map

keySet

public final java.util.Set keySet()

Specified by:

keySet in interface java.util.Map

put

public final java.lang.Object put(java.lang.Object key,
                                  java.lang.Object newValue)

Specified by:

put in interface java.util.Map

putAll

public final void putAll(java.util.Map newMap)

Specified by:

putAll in interface java.util.Map

remove

public final java.lang.Object remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map

size

public final int size()

Specified by:

size in interface java.util.Map

values

public final java.util.Collection values()

Specified by:

values in interface java.util.Map

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object