Class IndirectMap<K,V>
- java.lang.Object
-
- java.util.Dictionary<K,V>
-
- java.util.Hashtable<K,V>
-
- org.eclipse.persistence.indirection.IndirectMap<K,V>
-
- Type Parameters:
K- the type of keys maintained by this mapV- the type of mapped values
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,java.util.Map<K,V>,ChangeTracker,CollectionChangeTracker,IndirectCollection,IndirectContainer
public class IndirectMap<K,V> extends java.util.Hashtable<K,V> implements CollectionChangeTracker, IndirectCollection
IndirectMap allows a domain class to take advantage of TopLink indirection without having to declare its instance variable as a ValueHolderInterface.To use an IndirectMap:
- Declare the appropriate instance variable with type Map or Hashtable
- Send the message #useTransparentMap(String) to the appropriate CollectionMapping.
- See Also:
CollectionMapping,IndirectList, Serialized Form- Author:
- Big Country
- Since:
- TOPLink/Java 2.5
-
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Hashtable<K,V>delegateReduce type castingprotected intinitialCapacityStore initial size for lazy init.protected floatloadFactorStore load factor for lazy init.protected ValueHolderInterfacevalueHolderDelegate indirection behavior to a value holder
-
Constructor Summary
Constructors Constructor Description IndirectMap()PUBLIC: Construct a new, empty IndirectMap with a default capacity and load factor.IndirectMap(int initialCapacity)PUBLIC: Construct a new, empty IndirectMap with the specified initial capacity and default load factor.IndirectMap(int initialCapacity, float loadFactor)PUBLIC: Construct a new, empty IndirectMap with the specified initial capacity and load factor.IndirectMap(java.util.Map<? extends K,? extends V> m)PUBLIC: Construct a new IndirectMap with the same mappings as the given Map.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.beans.PropertyChangeListener_persistence_getPropertyChangeListener()Return the property change listener for change tracking.void_persistence_setPropertyChangeListener(java.beans.PropertyChangeListener changeListener)INTERNAL: Set the property change listener for change tracking.protected java.util.Hashtable<K,V>buildDelegate()Return the freshly-built delegate.voidclear()voidclearDeferredChanges()INTERNAL: clear any changes that have been deferred to instantiation.java.lang.Objectclone()Vcompute(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)VcomputeIfAbsent(K key, java.util.function.Function<? super K,? extends V> mappingFunction)VcomputeIfPresent(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)booleancontains(java.lang.Object value)booleancontainsKey(java.lang.Object key)booleancontainsValue(java.lang.Object value)java.util.Enumeration<V>elements()java.util.Set<java.util.Map.Entry<K,V>>entrySet()booleanequals(java.lang.Object o)voidforEach(java.util.function.BiConsumer<? super K,? super V> action)Vget(java.lang.Object key)java.util.Collection<java.util.Map.Entry<K,V>>getAddedElements()INTERNAL: Return the elements that have been added before instantiation.protected java.util.Hashtable<K,V>getDelegate()INTERNAL: Check whether the contents have been read from the database.java.lang.ObjectgetDelegateObject()INTERNAL: Return the real collection object.VgetOrDefault(java.lang.Object key, V defaultValue)java.util.Collection<java.util.Map.Entry<K,V>>getRemovedElements()INTERNAL: Return the elements that have been removed before instantiation.java.lang.StringgetTrackedAttributeName()INTERNAL: Return the mapping attribute name, used to raise change events.ValueHolderInterfacegetValueHolder()PUBLIC: Return the valueHolder.booleanhasDeferredChanges()INTERNAL: Return if any elements that have been added or removed before instantiation.inthashCode()booleanhasTrackedPropertyChangeListener()INTERNAL: Return if the collection has a property change listener for change tracking.protected voidinitialize(int initialCapacity, float loadFactor)Initialize the instance.protected voidinitialize(java.util.Map<? extends K,? extends V> m)Initialize the instance.booleanisEmpty()booleanisInstantiated()PUBLIC: Return whether the contents have been read from the database.java.util.Enumeration<K>keys()java.util.Set<K>keySet()Vmerge(K key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)Vput(K key, V value)voidputAll(java.util.Map<? extends K,? extends V> t)VputIfAbsent(K key, V value)protected voidraiseAddChangeEvent(java.lang.Object key, java.lang.Object value)Raise the add change event and relationship maintainence.protected voidraiseRemoveChangeEvent(java.lang.Object key, java.lang.Object value)Raise the remove change event.protected voidrehash()Vremove(java.lang.Object key)booleanremove(java.lang.Object key, java.lang.Object value)Vreplace(K key, V value)booleanreplace(K key, V oldValue, V newValue)voidreplaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)voidsetTrackedAttributeName(java.lang.String attributeName)INTERNAL: Set the mapping attribute name, used to raise change events.voidsetUseLazyInstantiation(boolean useLazyInstantiation)INTERNAL Set whether this collection should attempt do deal with adds and removes without retrieving the collection from the dBvoidsetValueHolder(ValueHolderInterface valueHolder)INTERNAL: Set the value holder.intsize()java.lang.StringtoString()PUBLIC: Use the Hashtable.toString(); but wrap it with braces to indicate there is a bit of indirection.java.util.Collection<V>values()
-
-
-
Field Detail
-
valueHolder
protected volatile ValueHolderInterface valueHolder
Delegate indirection behavior to a value holder
-
initialCapacity
protected int initialCapacity
Store initial size for lazy init.
-
loadFactor
protected float loadFactor
Store load factor for lazy init.
-
-
Constructor Detail
-
IndirectMap
public IndirectMap()
PUBLIC: Construct a new, empty IndirectMap with a default capacity and load factor.
-
IndirectMap
public IndirectMap(int initialCapacity)
PUBLIC: Construct a new, empty IndirectMap with the specified initial capacity and default load factor.- Parameters:
initialCapacity- the initial capacity of the hashtable
-
IndirectMap
public IndirectMap(int initialCapacity, float loadFactor)PUBLIC: Construct a new, empty IndirectMap with the specified initial capacity and load factor.- Parameters:
initialCapacity- the initial capacity of the hashtableloadFactor- a number between 0.0 and 1.0- Throws:
java.lang.IllegalArgumentException- if the initial capacity is less than or equal to zero, or if the load factor is less than or equal to zero
-
IndirectMap
public IndirectMap(java.util.Map<? extends K,? extends V> m)
PUBLIC: Construct a new IndirectMap with the same mappings as the given Map. The IndirectMap is created with a capacity of twice the number of entries in the given Map or 11 (whichever is greater), and a default load factor, which is 0.75.- Parameters:
m- a map containing the mappings to use
-
-
Method Detail
-
buildDelegate
protected java.util.Hashtable<K,V> buildDelegate()
Return the freshly-built delegate.
-
clear
public void clear()
-
clearDeferredChanges
public void clearDeferredChanges()
INTERNAL: clear any changes that have been deferred to instantiation. Indirect collections with change tracking avoid instantiation on add/remove.- Specified by:
clearDeferredChangesin interfaceIndirectCollection
-
clone
public java.lang.Object clone()
-
contains
public boolean contains(java.lang.Object value)
-
containsKey
public boolean containsKey(java.lang.Object key)
-
containsValue
public boolean containsValue(java.lang.Object value)
-
elements
public java.util.Enumeration<V> elements()
-
equals
public boolean equals(java.lang.Object o)
-
get
public V get(java.lang.Object key)
-
getDelegate
protected java.util.Hashtable<K,V> getDelegate()
INTERNAL: Check whether the contents have been read from the database. If they have not, read them and set the delegate. This method used to be synchronized, which caused deadlock.
-
getDelegateObject
public java.lang.Object getDelegateObject()
INTERNAL: Return the real collection object. This will force instantiation.- Specified by:
getDelegateObjectin interfaceIndirectCollection
-
getTrackedAttributeName
public java.lang.String getTrackedAttributeName()
INTERNAL: Return the mapping attribute name, used to raise change events.- Specified by:
getTrackedAttributeNamein interfaceCollectionChangeTracker
-
_persistence_getPropertyChangeListener
public java.beans.PropertyChangeListener _persistence_getPropertyChangeListener()
Return the property change listener for change tracking.- Specified by:
_persistence_getPropertyChangeListenerin interfaceChangeTracker
-
getValueHolder
public ValueHolderInterface getValueHolder()
PUBLIC: Return the valueHolder. This method used to be synchronized, which caused deadlock.- Specified by:
getValueHolderin interfaceIndirectContainer- Returns:
- org.eclipse.persistence.indirection.ValueHolderInterface A representation of the valueholder * which this container uses
-
hashCode
public int hashCode()
-
hasTrackedPropertyChangeListener
public boolean hasTrackedPropertyChangeListener()
INTERNAL: Return if the collection has a property change listener for change tracking.
-
initialize
protected void initialize(int initialCapacity, float loadFactor)Initialize the instance.
-
initialize
protected void initialize(java.util.Map<? extends K,? extends V> m)
Initialize the instance.
-
isEmpty
public boolean isEmpty()
-
isInstantiated
public boolean isInstantiated()
PUBLIC: Return whether the contents have been read from the database.- Specified by:
isInstantiatedin interfaceIndirectContainer
-
keys
public java.util.Enumeration<K> keys()
-
keySet
public java.util.Set<K> keySet()
-
compute
public V compute(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
-
computeIfAbsent
public V computeIfAbsent(K key, java.util.function.Function<? super K,? extends V> mappingFunction)
-
computeIfPresent
public V computeIfPresent(K key, java.util.function.BiFunction<? super K,? super V,? extends V> remappingFunction)
-
merge
public V merge(K key, V value, java.util.function.BiFunction<? super V,? super V,? extends V> remappingFunction)
-
remove
public boolean remove(java.lang.Object key, java.lang.Object value)
-
replaceAll
public void replaceAll(java.util.function.BiFunction<? super K,? super V,? extends V> function)
-
rehash
protected void rehash()
-
raiseAddChangeEvent
protected void raiseAddChangeEvent(java.lang.Object key, java.lang.Object value)Raise the add change event and relationship maintainence.
-
raiseRemoveChangeEvent
protected void raiseRemoveChangeEvent(java.lang.Object key, java.lang.Object value)Raise the remove change event.
-
remove
public V remove(java.lang.Object key)
-
setTrackedAttributeName
public void setTrackedAttributeName(java.lang.String attributeName)
INTERNAL: Set the mapping attribute name, used to raise change events. This is required if the change listener is set.- Specified by:
setTrackedAttributeNamein interfaceCollectionChangeTracker
-
_persistence_setPropertyChangeListener
public void _persistence_setPropertyChangeListener(java.beans.PropertyChangeListener changeListener)
INTERNAL: Set the property change listener for change tracking.- Specified by:
_persistence_setPropertyChangeListenerin interfaceChangeTracker
-
setValueHolder
public void setValueHolder(ValueHolderInterface valueHolder)
INTERNAL: Set the value holder.- Specified by:
setValueHolderin interfaceIndirectContainer
-
size
public int size()
-
setUseLazyInstantiation
public void setUseLazyInstantiation(boolean useLazyInstantiation)
INTERNAL Set whether this collection should attempt do deal with adds and removes without retrieving the collection from the dB- Specified by:
setUseLazyInstantiationin interfaceIndirectCollection
-
getRemovedElements
public java.util.Collection<java.util.Map.Entry<K,V>> getRemovedElements()
INTERNAL: Return the elements that have been removed before instantiation.- Specified by:
getRemovedElementsin interfaceIndirectCollection
-
getAddedElements
public java.util.Collection<java.util.Map.Entry<K,V>> getAddedElements()
INTERNAL: Return the elements that have been added before instantiation.- Specified by:
getAddedElementsin interfaceIndirectCollection
-
hasDeferredChanges
public boolean hasDeferredChanges()
INTERNAL: Return if any elements that have been added or removed before instantiation.- Specified by:
hasDeferredChangesin interfaceIndirectCollection
-
toString
public java.lang.String toString()
PUBLIC: Use the Hashtable.toString(); but wrap it with braces to indicate there is a bit of indirection. Don't allow this method to trigger a database read.
-
-