Package com.uwyn.jhighlight.pcj.map

Class AbstractCharKeyMap

java.lang.Object
com.uwyn.jhighlight.pcj.map.AbstractCharKeyMap
All Implemented Interfaces:
CharKeyMap
Direct Known Subclasses:
CharKeyOpenHashMap
public abstract class AbstractCharKeyMap extends Object implements CharKeyMap
This class represents an abstract base for implementing maps from char values to objects. All operations that can be implemented using iterators are implemented as such. In most cases, this is hardly an efficient solution, and at least some of those methods should be overridden by sub-classes.
Since:
1.0
Version:
1.0 2003/10/1

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractCharKeyMap()
    Default constructor to be invoked by sub-classes.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Clears this map.
    boolean
    containsKey(char key)
    Indicates whether this map contains a mapping from a specified key.
    boolean
    containsValue(Object value)
    Indicates whether this map contains a mapping to a specified value.
    boolean
    equals(Object obj)
    Indicates whether this map is equal to some object.
    Object
    get(char key)
    Maps a specified key to a value.
    int
    hashCode()
    Returns a hash code value for this map.
    boolean
    isEmpty()
    Indicates whether this map is empty.
    void
    putAll(CharKeyMap map)
    Adds all mappings from a specified map to this map.
    Object
    remove(char key)
    Removes the mapping from a specified key from this map.
    int
    size()
    Returns the size of this map.
    String
    toString()
    Returns a string representation of this map.
    void
    trimToSize()
    Does nothing.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.uwyn.jhighlight.pcj.map.CharKeyMap

    entries, keySet, put, values

  • Constructor Details

    • AbstractCharKeyMap

      protected AbstractCharKeyMap()
      Default constructor to be invoked by sub-classes.

  • Method Details

    • clear

      public void clear()
      Description copied from interface: CharKeyMap
      Clears this map.
      Specified by:
      clear in interface CharKeyMap

    • remove

      public Object remove(char key)
      Description copied from interface: CharKeyMap
      Removes the mapping from a specified key from this map.
      Specified by:
      remove in interface CharKeyMap
      Parameters:
      key - the key whose mapping to remove from this map.
      Returns:
      the old value (which can be null) if a mapping from the specified key already existed in this map; returns null otherwise.

    • putAll

      public void putAll(CharKeyMap map)
      Description copied from interface: CharKeyMap
      Adds all mappings from a specified map to this map. Any existing mappings whose keys collide with a new mapping is overwritten by the new mapping.
      Specified by:
      putAll in interface CharKeyMap
      Parameters:
      map - the map whose mappings to add to this map.

    • containsKey

      public boolean containsKey(char key)
      Description copied from interface: CharKeyMap
      Indicates whether this map contains a mapping from a specified key.
      Specified by:
      containsKey in interface CharKeyMap
      Parameters:
      key - the key to test for.
      Returns:
      true if this map contains a mapping from the specified key; returns false otherwise.

    • get

      public Object get(char key)
      Description copied from interface: CharKeyMap
      Maps a specified key to a value.
      Specified by:
      get in interface CharKeyMap
      Parameters:
      key - the key to map to a value.
      Returns:
      the value that the specified key maps to; returns null, if no mapping exists for the specified key.

    • containsValue

      public boolean containsValue(Object value)
      Description copied from interface: CharKeyMap
      Indicates whether this map contains a mapping to a specified value.
      Specified by:
      containsValue in interface CharKeyMap
      Parameters:
      value - the value to test for.
      Returns:
      true if this map contains at least one mapping to the specified value; returns false otherwise.

    • equals

      public boolean equals(Object obj)
      Description copied from interface: CharKeyMap
      Indicates whether this map is equal to some object.
      Specified by:
      equals in interface CharKeyMap
      Overrides:
      equals in class Object
      Parameters:
      obj - the object with which to compare this map.
      Returns:
      true if this map is equal to the specified object; returns false otherwise.

    • hashCode

      public int hashCode()
      Description copied from interface: CharKeyMap
      Returns a hash code value for this map.
      Specified by:
      hashCode in interface CharKeyMap
      Overrides:
      hashCode in class Object
      Returns:
      a hash code value for this map.

    • isEmpty

      public boolean isEmpty()
      Description copied from interface: CharKeyMap
      Indicates whether this map is empty.
      Specified by:
      isEmpty in interface CharKeyMap
      Returns:
      true if this map is empty; returns false otherwise.

    • size

      public int size()
      Description copied from interface: CharKeyMap
      Returns the size of this map. The size is defined as the number of mappings from keys to values.
      Specified by:
      size in interface CharKeyMap
      Returns:
      the size of this map.

    • toString

      public String toString()
      Returns a string representation of this map.
      Overrides:
      toString in class Object
      Returns:
      a string representation of this map.

    • trimToSize

      public void trimToSize()
      Does nothing. Sub-classes may provide an implementation to minimize memory usage, but this is not required since many implementations will always have minimal memory usage.