org.apache.jdo.sco
Interface SCOMap

All Superinterfaces:
java.util.Map, SCO
All Known Implementing Classes:
HashMap, Hashtable, TreeMap

public interface SCOMap
extends java.util.Map, SCO


Nested Class Summary
 
Nested classes inherited from class java.util.Map
java.util.Map.Entry
 
Method Summary
 boolean allowNulls()
          Returns whether nulls are permitted as keys or values.
 void clearInternal()
          Clears Map without recording the event.
 java.util.Iterator eitherIterator()
          Get an iterator regardless of whether the map is frozen.
 java.util.Iterator frozenIterator()
          Get an iterator over the frozen elements of this map.
 java.util.Collection getAddedKeys()
          Returns the Collection of added keys
 java.util.Collection getAddedValues()
          Returns the Collection of added values
 java.lang.Class getKeyType()
          Returns the type of the key assignment compatible with all keys of this map.
 java.util.Collection getRemovedKeys()
          Returns the Collection of removed keys
 java.util.Collection getRemovedValues()
          Returns the Collection of removed values
 java.lang.Class getValueType()
          Returns the type of the value assignment compatible with all values of this map.
 void putAllInternal(java.util.Map t)
          Copies all of the mappings from the specified map to this one without recording the event.
 void putInternal(java.lang.Object key, java.lang.Object value)
          Associates the specified value with the specified key in this map without recording the event.
 void removeInternal(java.lang.Object key)
          Removes mappings from the Map without recording the event.
 void reset()
          Resets removed and added lists after flush
 void setFrozen(java.util.Map.Entry[] entries)
          Set the contents of this Map from the frozen entries.
 
Methods inherited from interface java.util.Map
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values
 
Methods inherited from interface org.apache.jdo.sco.SCO
clone, getFieldName, getOwner, setOwner, unsetOwner
 

Method Detail

reset

public void reset()
Resets removed and added lists after flush


putInternal

public void putInternal(java.lang.Object key,
                        java.lang.Object value)
Associates the specified value with the specified key in this map without recording the event. Used internaly to initially populate the Map.


putAllInternal

public void putAllInternal(java.util.Map t)
Copies all of the mappings from the specified map to this one without recording the event. Used internaly to initially populate the Map.


clearInternal

public void clearInternal()
Clears Map without recording the event. Used internaly to clear the Map


removeInternal

public void removeInternal(java.lang.Object key)
Removes mappings from the Map without recording the event. Used internally to update the Map


getAddedKeys

public java.util.Collection getAddedKeys()
Returns the Collection of added keys

Returns:
Collection of the added keys as java.util.Collection

getAddedValues

public java.util.Collection getAddedValues()
Returns the Collection of added values

Returns:
Collection of the added values as java.util.Collection

getRemovedKeys

public java.util.Collection getRemovedKeys()
Returns the Collection of removed keys

Returns:
Collection of the removed keys as java.util.Collection

getRemovedValues

public java.util.Collection getRemovedValues()
Returns the Collection of removed values

Returns:
Collection of the removed values as java.util.Collection

getKeyType

public java.lang.Class getKeyType()
Returns the type of the key assignment compatible with all keys of this map.

Returns:
the type of the key assignment compatible with all keys.

getValueType

public java.lang.Class getValueType()
Returns the type of the value assignment compatible with all values of this map.

Returns:
the type of the value assignment compatible with all values.

allowNulls

public boolean allowNulls()
Returns whether nulls are permitted as keys or values.

Returns:
true if nulls are permitted as keys or values.

setFrozen

public void setFrozen(java.util.Map.Entry[] entries)
Set the contents of this Map from the frozen entries.

Parameters:
entries - the array of entries
Since:
1.0.1

eitherIterator

public java.util.Iterator eitherIterator()
Get an iterator regardless of whether the map is frozen. If frozen, get a frozen iterator. If thawed, get a regular iterator.

Returns:
an iterator over the map entries.
Since:
1.0.1

frozenIterator

public java.util.Iterator frozenIterator()
Get an iterator over the frozen elements of this map. This allows iteration of the elements without thawing them, as is needed for transcription.

Returns:
an iterator over the frozen map entries.
Since:
1.0.1