net.sf.joafip.java.util

Class PTreeMap<K,V>

java.lang.Object

net.sf.joafip.java.util.PAbstractMap<K,V>

net.sf.joafip.java.util.PTreeMap<K,V>

Type Parameters:

K -

V -

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>, NavigableMap<K,V>, SortedMap<K,V>, ICollectionListener<Map.Entry<K,V>>, IMapListenable<K,V>

@StoreNotUseStandardSerialization
@StorableClass
public class PTreeMap<K,V>
extends PAbstractMap<K,V>
implements NavigableMap<K,V>, Cloneable, Serializable

A Red-Black tree based persistable map implementation

Author:

luc peuvrier

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor and Description
	PTreeMap()
	PTreeMap(boolean concurrentAccess)
	PTreeMap(Comparator<K> comparator)
	PTreeMap(Comparator<K> comparator, boolean concurrentAccess)
protected	PTreeMap(IInstanceFactory instanceFactory)
protected	PTreeMap(IInstanceFactory instanceFactory, boolean concurrentAccess)
protected	PTreeMap(IInstanceFactory instanceFactory, Comparator<K> comparator)
protected	PTreeMap(IInstanceFactory instanceFactory, Comparator<K> comparator, boolean concurrentAccess)
protected	PTreeMap(IInstanceFactory instanceFactory, Map<? extends K,? extends V> map)
protected	PTreeMap(IInstanceFactory instanceFactory, Map<? extends K,? extends V> map, boolean concurrentAccess)
protected	PTreeMap(IInstanceFactory instanceFactory, SortedMap<K,? extends V> map)
protected	PTreeMap(IInstanceFactory instanceFactory, SortedMap<K,? extends V> map, boolean concurrentAccess)
	PTreeMap(Map<? extends K,? extends V> map)
	PTreeMap(Map<? extends K,? extends V> map, boolean concurrentAccess)
	PTreeMap(SortedMap<K,? extends V> map)
	PTreeMap(SortedMap<K,? extends V> map, boolean concurrentAccess)

Method Summary

Methods

Modifier and Type	Method and Description
void	addListerner(IMapListener<K,V> listener)
Map.Entry<K,V>	ceilingEntry(K key)
K	ceilingKey(K key)
void	clear()
PTreeMap	clone()
Comparator<? super K>	comparator()
boolean	containsKey(Object key)
NavigableSet<K>	descendingKeySet()
NavigableMap<K,V>	descendingMap()
Set<Map.Entry<K,V>>	entrySet()
Map.Entry<K,V>	firstEntry()
K	firstKey()
Map.Entry<K,V>	floorEntry(K key)
K	floorKey(K key)
V	get(Object key)
int	getIdentifier()
IPTreeSet<Map.Entry<K,V>>	getPTreeSet()
SortedMap<K,V>	headMap(K toKey)
NavigableMap<K,V>	headMap(K toKey, boolean inclusive)
Map.Entry<K,V>	higherEntry(K key)
K	higherKey(K key)
Set<K>	keySet()
Map.Entry<K,V>	lastEntry()
K	lastKey()
Map.Entry<K,V>	lowerEntry(K key)
K	lowerKey(K key)
NavigableSet<K>	navigableKeySet()
static PTreeMap	newInstance(IInstanceFactory instanceFactory)
static PTreeMap	newInstance(IInstanceFactory instanceFactory, boolean concurrentAccess)
static PTreeMap	newInstance(IInstanceFactory instanceFactory, Comparator comparator)
static PTreeMap	newInstance(IInstanceFactory instanceFactory, Comparator comparator, boolean concurrentAccess)
static PTreeMap	newInstance(IInstanceFactory instanceFactory, Map map)
static PTreeMap	newInstance(IInstanceFactory instanceFactory, Map map, boolean concurrentAccess)
static PTreeMap	newInstance(IInstanceFactory instanceFactory, SortedMap map)
static PTreeMap	newInstance(IInstanceFactory instanceFactory, SortedMap map, boolean concurrentAccess)
void	notifyAdded(Map.Entry<K,V> added)
void	notifyRemoved(Map.Entry<K,V> removed)
Map.Entry<K,V>	pollFirstEntry()
K	pollFirstKey()
Map.Entry<K,V>	pollLastEntry()
K	pollLastKey()
V	put(K key, V value)
V	remove(Object key)
void	removeListener(int listenerIdentifier)
void	setTreeSet(IPNavigableTreeSet<Map.Entry<K,V>> treeSet)
int	size()
NavigableMap<K,V>	subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
SortedMap<K,V>	subMap(K fromKey, K toKey)
SortedMap<K,V>	tailMap(K fromKey)
NavigableMap<K,V>	tailMap(K fromKey, boolean inclusive)
Collection<V>	values()

Methods inherited from class net.sf.joafip.java.util.PAbstractMap

containsValue, equals, hashCode, isEmpty, putAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

containsValue, equals, hashCode, isEmpty, putAll

Constructor Detail

PTreeMap

public PTreeMap()

PTreeMap

protected PTreeMap(IInstanceFactory instanceFactory)

PTreeMap

public PTreeMap(boolean concurrentAccess)

PTreeMap

protected PTreeMap(IInstanceFactory instanceFactory,
        boolean concurrentAccess)

PTreeMap

public PTreeMap(Comparator<K> comparator)

PTreeMap

protected PTreeMap(IInstanceFactory instanceFactory,
        Comparator<K> comparator)

PTreeMap

public PTreeMap(Comparator<K> comparator,
        boolean concurrentAccess)

PTreeMap

protected PTreeMap(IInstanceFactory instanceFactory,
        Comparator<K> comparator,
        boolean concurrentAccess)

PTreeMap

public PTreeMap(Map<? extends K,? extends V> map)

PTreeMap

protected PTreeMap(IInstanceFactory instanceFactory,
        Map<? extends K,? extends V> map)

PTreeMap

public PTreeMap(Map<? extends K,? extends V> map,
        boolean concurrentAccess)

PTreeMap

protected PTreeMap(IInstanceFactory instanceFactory,
        Map<? extends K,? extends V> map,
        boolean concurrentAccess)

PTreeMap

public PTreeMap(SortedMap<K,? extends V> map)

PTreeMap

protected PTreeMap(IInstanceFactory instanceFactory,
        SortedMap<K,? extends V> map)

PTreeMap

public PTreeMap(SortedMap<K,? extends V> map,
        boolean concurrentAccess)

PTreeMap

protected PTreeMap(IInstanceFactory instanceFactory,
        SortedMap<K,? extends V> map,
        boolean concurrentAccess)

Method Detail

newInstance

public static PTreeMap newInstance(IInstanceFactory instanceFactory)

newInstance

public static PTreeMap newInstance(IInstanceFactory instanceFactory,
                   boolean concurrentAccess)

newInstance

public static PTreeMap newInstance(IInstanceFactory instanceFactory,
                   Comparator comparator)

newInstance

public static PTreeMap newInstance(IInstanceFactory instanceFactory,
                   Comparator comparator,
                   boolean concurrentAccess)

newInstance

public static PTreeMap newInstance(IInstanceFactory instanceFactory,
                   Map map)

newInstance

public static PTreeMap newInstance(IInstanceFactory instanceFactory,
                   Map map,
                   boolean concurrentAccess)

newInstance

public static PTreeMap newInstance(IInstanceFactory instanceFactory,
                   SortedMap map)

newInstance

public static PTreeMap newInstance(IInstanceFactory instanceFactory,
                   SortedMap map,
                   boolean concurrentAccess)

addListerner

public void addListerner(IMapListener<K,V> listener)

Specified by:

addListerner in interface IMapListenable<K,V>

removeListener

public void removeListener(int listenerIdentifier)

Specified by:

removeListener in interface IMapListenable<K,V>

getIdentifier

public int getIdentifier()

Specified by:

getIdentifier in interface ICollectionListener<Map.Entry<K,V>>

Returns:

identifier of the listener implementation instance

notifyAdded

public void notifyAdded(Map.Entry<K,V> added)

Specified by:

notifyAdded in interface ICollectionListener<Map.Entry<K,V>>

notifyRemoved

public void notifyRemoved(Map.Entry<K,V> removed)

Specified by:

notifyRemoved in interface ICollectionListener<Map.Entry<K,V>>

size

public int size()

Specified by:

size in interface Map<K,V>

Overrides:

size in class PAbstractMap<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K,V>

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,V>

firstEntry

public Map.Entry<K,V> firstEntry()

Specified by:

firstEntry in interface NavigableMap<K,V>

pollFirstEntry

public Map.Entry<K,V> pollFirstEntry()

Specified by:

pollFirstEntry in interface NavigableMap<K,V>

pollFirstKey

public K pollFirstKey()

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,V>

lastEntry

public Map.Entry<K,V> lastEntry()

Specified by:

lastEntry in interface NavigableMap<K,V>

pollLastEntry

public Map.Entry<K,V> pollLastEntry()

Specified by:

pollLastEntry in interface NavigableMap<K,V>

pollLastKey

public K pollLastKey()

lowerEntry

public Map.Entry<K,V> lowerEntry(K key)

Specified by:

lowerEntry in interface NavigableMap<K,V>

lowerKey

public K lowerKey(K key)

Specified by:

lowerKey in interface NavigableMap<K,V>

floorEntry

public Map.Entry<K,V> floorEntry(K key)

Specified by:

floorEntry in interface NavigableMap<K,V>

floorKey

public K floorKey(K key)

Specified by:

floorKey in interface NavigableMap<K,V>

ceilingEntry

public Map.Entry<K,V> ceilingEntry(K key)

Specified by:

ceilingEntry in interface NavigableMap<K,V>

ceilingKey

public K ceilingKey(K key)

Specified by:

ceilingKey in interface NavigableMap<K,V>

higherEntry

public Map.Entry<K,V> higherEntry(K key)

Specified by:

higherEntry in interface NavigableMap<K,V>

higherKey

public K higherKey(K key)

Specified by:

higherKey in interface NavigableMap<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface SortedMap<K,V>

navigableKeySet

public NavigableSet<K> navigableKeySet()

Specified by:

navigableKeySet in interface NavigableMap<K,V>

descendingKeySet

public NavigableSet<K> descendingKeySet()

Specified by:

descendingKeySet in interface NavigableMap<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

Specified by:

values in interface SortedMap<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface SortedMap<K,V>

Specified by:

entrySet in class PAbstractMap<K,V>

getPTreeSet

public IPTreeSet<Map.Entry<K,V>> getPTreeSet()

descendingMap

public NavigableMap<K,V> descendingMap()

Specified by:

descendingMap in interface NavigableMap<K,V>

subMap

public NavigableMap<K,V> subMap(K fromKey,
                       boolean fromInclusive,
                       K toKey,
                       boolean toInclusive)

Specified by:

subMap in interface NavigableMap<K,V>

headMap

public NavigableMap<K,V> headMap(K toKey,
                        boolean inclusive)

Specified by:

headMap in interface NavigableMap<K,V>

tailMap

public NavigableMap<K,V> tailMap(K fromKey,
                        boolean inclusive)

Specified by:

tailMap in interface NavigableMap<K,V>

subMap

public SortedMap<K,V> subMap(K fromKey,
                    K toKey)

Specified by:

subMap in interface NavigableMap<K,V>

Specified by:

subMap in interface SortedMap<K,V>

headMap

public SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface NavigableMap<K,V>

Specified by:

headMap in interface SortedMap<K,V>

tailMap

public SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface NavigableMap<K,V>

Specified by:

tailMap in interface SortedMap<K,V>

put

public V put(K key,
    V value)

Specified by:

put in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

clone

public PTreeMap clone()

Overrides:

clone in class Object

setTreeSet

public void setTreeSet(IPNavigableTreeSet<Map.Entry<K,V>> treeSet)