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:
Serializable
,Cloneable
,Map<K,V>
,ChangeTracker
,CollectionChangeTracker
,IndirectCollection
,IndirectContainer
public class IndirectMap<K,V> extends 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.
- Since:
- TOPLink/Java 2.5
- Author:
- Big Country
- See Also:
CollectionMapping
,IndirectList
, Serialized Form
-
-
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(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 PropertyChangeListener
_persistence_getPropertyChangeListener()
Return the property change listener for change tracking.void
_persistence_setPropertyChangeListener(PropertyChangeListener changeListener)
INTERNAL: Set the property change listener for change tracking.void
clear()
void
clearDeferredChanges()
INTERNAL: clear any changes that have been deferred to instantiation.Object
clone()
boolean
contains(Object value)
boolean
containsKey(Object key)
boolean
containsValue(Object value)
Enumeration<V>
elements()
Set<Map.Entry<K,V>>
entrySet()
boolean
equals(Object o)
V
get(Object key)
Collection
getAddedElements()
INTERNAL: Return the elements that have been added before instantiation.Object
getDelegateObject()
INTERNAL: Return the real collection object.Collection
getRemovedElements()
INTERNAL: Return the elements that have been removed before instantiation.String
getTrackedAttributeName()
INTERNAL: Return the mapping attribute name, used to raise change events.ValueHolderInterface
getValueHolder()
PUBLIC: Return the valueHolder.boolean
hasDeferredChanges()
INTERNAL: Return if any elements that have been added or removed before instantiation.int
hashCode()
boolean
hasTrackedPropertyChangeListener()
INTERNAL: Return if the collection has a property change listener for change tracking.boolean
isEmpty()
boolean
isInstantiated()
PUBLIC: Return whether the contents have been read from the database.Enumeration<K>
keys()
Set<K>
keySet()
V
put(K key, V value)
void
putAll(Map<? extends K,? extends V> t)
V
remove(Object key)
void
setTrackedAttributeName(String attributeName)
INTERNAL: Set the mapping attribute name, used to raise change events.void
setUseLazyInstantiation(boolean useLazyInstantiation)
INTERNAL Set whether this collection should attempt do deal with adds and removes without retrieving the collection from the dBvoid
setValueHolder(ValueHolderInterface valueHolder)
INTERNAL: Set the value holder.int
size()
String
toString()
PUBLIC: Use the Hashtable.toString(); but wrap it with braces to indicate there is a bit of indirection.Collection<V>
values()
-
Methods inherited from class java.util.Hashtable
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
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:
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(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
-
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:
clearDeferredChanges
in interfaceIndirectCollection
-
clone
public Object clone()
- Overrides:
clone
in classHashtable<K,V>
- See Also:
This will result in a database query if necessary.
-
contains
public boolean contains(Object value)
- Overrides:
contains
in classHashtable<K,V>
- See Also:
Hashtable.contains(java.lang.Object)
-
containsKey
public boolean containsKey(Object key)
- Specified by:
containsKey
in interfaceMap<K,V>
- Overrides:
containsKey
in classHashtable<K,V>
- See Also:
Hashtable.containsKey(java.lang.Object)
-
containsValue
public boolean containsValue(Object value)
- Specified by:
containsValue
in interfaceMap<K,V>
- Overrides:
containsValue
in classHashtable<K,V>
- See Also:
Hashtable.containsValue(java.lang.Object)
-
elements
public Enumeration<V> elements()
- Overrides:
elements
in classHashtable<K,V>
- See Also:
Hashtable.elements()
-
equals
public boolean equals(Object o)
-
getDelegateObject
public Object getDelegateObject()
INTERNAL: Return the real collection object. This will force instantiation.- Specified by:
getDelegateObject
in interfaceIndirectCollection
-
getTrackedAttributeName
public String getTrackedAttributeName()
INTERNAL: Return the mapping attribute name, used to raise change events.- Specified by:
getTrackedAttributeName
in interfaceCollectionChangeTracker
-
_persistence_getPropertyChangeListener
public PropertyChangeListener _persistence_getPropertyChangeListener()
Return the property change listener for change tracking.- Specified by:
_persistence_getPropertyChangeListener
in interfaceChangeTracker
-
getValueHolder
public ValueHolderInterface getValueHolder()
PUBLIC: Return the valueHolder. This method used to be synchronized, which caused deadlock.- Specified by:
getValueHolder
in 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.
-
isEmpty
public boolean isEmpty()
-
isInstantiated
public boolean isInstantiated()
PUBLIC: Return whether the contents have been read from the database.- Specified by:
isInstantiated
in interfaceIndirectContainer
-
keys
public Enumeration<K> keys()
- Overrides:
keys
in classHashtable<K,V>
- See Also:
Hashtable.keys()
-
setTrackedAttributeName
public void setTrackedAttributeName(String attributeName)
INTERNAL: Set the mapping attribute name, used to raise change events. This is required if the change listener is set.- Specified by:
setTrackedAttributeName
in interfaceCollectionChangeTracker
-
_persistence_setPropertyChangeListener
public void _persistence_setPropertyChangeListener(PropertyChangeListener changeListener)
INTERNAL: Set the property change listener for change tracking.- Specified by:
_persistence_setPropertyChangeListener
in interfaceChangeTracker
-
setValueHolder
public void setValueHolder(ValueHolderInterface valueHolder)
INTERNAL: Set the value holder.- Specified by:
setValueHolder
in 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:
setUseLazyInstantiation
in interfaceIndirectCollection
-
getRemovedElements
public Collection getRemovedElements()
INTERNAL: Return the elements that have been removed before instantiation.- Specified by:
getRemovedElements
in interfaceIndirectCollection
-
getAddedElements
public Collection getAddedElements()
INTERNAL: Return the elements that have been added before instantiation.- Specified by:
getAddedElements
in interfaceIndirectCollection
-
hasDeferredChanges
public boolean hasDeferredChanges()
INTERNAL: Return if any elements that have been added or removed before instantiation.- Specified by:
hasDeferredChanges
in interfaceIndirectCollection
-
toString
public 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.- Overrides:
toString
in classHashtable<K,V>
- See Also:
Hashtable.toString()
-
-