Class Hashtable<K,V>

java.lang.Object
java.util.Dictionary<K,V>
java.util.Hashtable<K,V>
org.datanucleus.store.types.wrappers.Hashtable<K,V>
All Implemented Interfaces:
Serializable, Cloneable, Map<K,V>, SCO<Hashtable<K,V>>, SCOContainer<Hashtable<K,V>>, SCOMap<Hashtable<K,V>, K, V>
Direct Known Subclasses:
Hashtable
public class Hashtable<K,V> extends Hashtable<K,V> implements SCOMap<Hashtable<K,V>, K, V>
A mutable second-class Hashtable object. This is the simplified form that intercepts mutators and marks the field as dirty. It also handles cascade-delete triggering for persistable elements.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • initialise

      public void initialise(Hashtable newValue, Object oldValue)
      Description copied from interface: SCO
      Method to initialise the SCO for use, where replacing an old value with a new value such as when calling a setter field passing in a new value. Note that oldValue is marked as Object since for cases where the member type is Collection the newValue could be, for example, ArrayList, and the oldValue of type Collection (representing null).
      Specified by:
      initialise in interface SCO<K>
      Parameters:
      newValue - New value (to wrap)
      oldValue - Old value (to use in deciding what needs deleting etc)

    • initialise

      public void initialise(Hashtable m)
      Description copied from interface: SCO
      Method to initialise the SCO for use with the provided initial value. This is used, for example, when retrieving the field from the datastore and setting it in the persistable object.
      Specified by:
      initialise in interface SCO<K>
      Parameters:
      m - the object from which to copy the value.

    • initialise

      public void initialise()
      Description copied from interface: SCO
      Method to initialise the SCO for use, and allowing the SCO to be loaded from the datastore (when we have a backing store). This can be utilised to perform any eager loading of information from the datastore.
      Specified by:
      initialise in interface SCO<K>

    • getValue

      public Hashtable getValue()
      Accessor for the unwrapped value that we are wrapping.
      Specified by:
      getValue in interface SCO<K>
      Returns:
      The unwrapped value

    • setValue

      public void setValue(Hashtable value)
      Description copied from interface: SCOContainer
      Method to change the delegate value this wraps (to save recreating the wrapper).
      Specified by:
      setValue in interface SCOContainer<K>
      Parameters:
      value - The new value

    • load

      public void load()
      Method to effect the load of the data in the SCO. Used when the SCO supports lazy-loading to tell it to load all now.
      Specified by:
      load in interface SCOContainer<K>

    • isLoaded

      public boolean isLoaded()
      Method to return if the SCO has its contents loaded. Returns true.
      Specified by:
      isLoaded in interface SCOContainer<K>
      Returns:
      Whether it is loaded

    • updateEmbeddedKey

      public void updateEmbeddedKey(K key, int fieldNumber, Object newValue, boolean makeDirty)
      Method to update an embedded key in this map.
      Specified by:
      updateEmbeddedKey in interface SCOMap<Hashtable<K,V>, K, V>
      Parameters:
      key - The key
      fieldNumber - Number of field in the key
      newValue - New value for this field
      makeDirty - Whether to make the SCO field dirty.

    • updateEmbeddedValue

      public void updateEmbeddedValue(V value, int fieldNumber, Object newValue, boolean makeDirty)
      Method to update an embedded value in this map.
      Specified by:
      updateEmbeddedValue in interface SCOMap<Hashtable<K,V>, K, V>
      Parameters:
      value - The value
      fieldNumber - Number of field in the value
      newValue - New value for this field
      makeDirty - Whether to make the SCO field dirty.

    • getFieldName

      public String getFieldName()
      Accessor for the field name that this Hashtable relates to.
      Specified by:
      getFieldName in interface SCO<K>
      Returns:
      The field name

    • getOwner

      public Object getOwner()
      Accessor for the owner that this Hashtable relates to.
      Specified by:
      getOwner in interface SCO<K>
      Returns:
      The owner

    • unsetOwner

      public void unsetOwner()
      Method to unset the owner and field details.
      Specified by:
      unsetOwner in interface SCO<K>

    • makeDirty

      public void makeDirty()
      Utility to mark the object as dirty

    • detachCopy

      public Hashtable detachCopy(FetchPlanState state)
      Method to return a detached copy of the container. Recurse sthrough the keys/values so that they are likewise detached.
      Specified by:
      detachCopy in interface SCO<K>
      Parameters:
      state - State for detachment process
      Returns:
      The detached container

    • attachCopy

      public void attachCopy(Hashtable value)
      Method to return an attached copy of the passed (detached) value. The returned attached copy is a SCO wrapper. Goes through the existing keys/values in the store for this owner field and removes ones no longer present, and adds new keys/values. All keys/values in the (detached) value are attached.
      Specified by:
      attachCopy in interface SCO<K>
      Parameters:
      value - The new (map) value

    • clone

      public Object clone()
      Creates and returns a copy of this object.

      Mutable second-class Objects are required to provide a public clone method in order to allow for copying persistable objects. In contrast to Object.clone(), this method must not throw a CloneNotSupportedException.

      Specified by:
      clone in interface SCO<K>
      Overrides:
      clone in class Hashtable<K,V>
      Returns:
      The cloned object

    • containsKey

      public boolean containsKey(Object key)
      Method to return if the map contains this key
      Specified by:
      containsKey in interface Map<K,V>
      Overrides:
      containsKey in class Hashtable<K,V>
      Parameters:
      key - The key
      Returns:
      Whether it is contained

    • containsValue

      public boolean containsValue(Object value)
      Method to return if the map contains this value.
      Specified by:
      containsValue in interface Map<K,V>
      Overrides:
      containsValue in class Hashtable<K,V>
      Parameters:
      value - The value
      Returns:
      Whether it is contained

    • entrySet

      public Set entrySet()
      Accessor for the set of entries in the Map.
      Specified by:
      entrySet in interface Map<K,V>
      Overrides:
      entrySet in class Hashtable<K,V>
      Returns:
      Set of entries

    • equals

      public boolean equals(Object o)
      Method to check the equality of this map, and another.
      Specified by:
      equals in interface Map<K,V>
      Overrides:
      equals in class Hashtable<K,V>
      Parameters:
      o - The map to compare against.
      Returns:
      Whether they are equal.

    • forEach

      public void forEach(BiConsumer<? super K, ? super V> action)
      Specified by:
      forEach in interface Map<K,V>
      Overrides:
      forEach in class Hashtable<K,V>

    • get

      public V get(Object key)
      Accessor for the value stored against a key.
      Specified by:
      get in interface Map<K,V>
      Overrides:
      get in class Hashtable<K,V>
      Parameters:
      key - The key
      Returns:
      The value.

    • hashCode

      public int hashCode()
      Method to generate a hashcode for this Map.
      Specified by:
      hashCode in interface Map<K,V>
      Overrides:
      hashCode in class Hashtable<K,V>
      Returns:
      The hashcode.

    • isEmpty

      public boolean isEmpty()
      Method to return if the Map is empty.
      Specified by:
      isEmpty in interface Map<K,V>
      Overrides:
      isEmpty in class Hashtable<K,V>
      Returns:
      Whether it is empty.

    • keySet

      public Set<K> keySet()
      Accessor for the set of keys in the Map.
      Specified by:
      keySet in interface Map<K,V>
      Overrides:
      keySet in class Hashtable<K,V>
      Returns:
      Set of keys.

    • size

      public int size()
      Method to return the size of the Map.
      Specified by:
      size in interface Map<K,V>
      Overrides:
      size in class Hashtable<K,V>
      Returns:
      The size

    • values

      public Collection<V> values()
      Accessor for the set of values in the Map.
      Specified by:
      values in interface Map<K,V>
      Overrides:
      values in class Hashtable<K,V>
      Returns:
      Set of values.

    • clear

      public void clear()
      Method to clear the Hashtable
      Specified by:
      clear in interface Map<K,V>
      Overrides:
      clear in class Hashtable<K,V>

    • put

      public V put(K key, V value)
      Method to add a value against a key to the Hashtable
      Specified by:
      put in interface Map<K,V>
      Overrides:
      put in class Hashtable<K,V>
      Parameters:
      key - The key
      value - The value
      Returns:
      The previous value for the specified key.

    • putAll

      public void putAll(Map m)
      Method to add the specified Map's values under their keys here.
      Specified by:
      putAll in interface Map<K,V>
      Overrides:
      putAll in class Hashtable<K,V>
      Parameters:
      m - The map

    • remove

      public V remove(Object key)
      Method to remove the value for a key from the Hashtable
      Specified by:
      remove in interface Map<K,V>
      Overrides:
      remove in class Hashtable<K,V>
      Parameters:
      key - The key to remove
      Returns:
      The value that was removed from this key.

    • writeReplace

      protected Object writeReplace() throws ObjectStreamException
      The writeReplace method is called when ObjectOutputStream is preparing to write the object to the stream. The ObjectOutputStream checks whether the class defines the writeReplace method. If the method is defined, the writeReplace method is called to allow the object to designate its replacement in the stream. The object returned should be either of the same type as the object passed in or an object that when read and resolved will result in an object of a type that is compatible with all references to the object.
      Returns:
      the replaced object
      Throws:
      ObjectStreamException - if an error occurs