Class TCharCharHashMap

  • All Implemented Interfaces:
    TCharCharMap, java.io.Externalizable, java.io.Serializable

    public class TCharCharHashMap
    extends TCharCharHash
    implements TCharCharMap, java.io.Externalizable
    An open addressed Map implementation for char keys and char values.
    See Also:
    Serialized Form
    • Field Detail

      • _values

        protected transient char[] _values
        the values of the map
    • Constructor Detail

      • TCharCharHashMap

        public TCharCharHashMap()
        Creates a new TCharCharHashMap instance with the default capacity and load factor.
      • TCharCharHashMap

        public TCharCharHashMap​(int initialCapacity)
        Creates a new TCharCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the default load factor.
        Parameters:
        initialCapacity - an int value
      • TCharCharHashMap

        public TCharCharHashMap​(int initialCapacity,
                                float loadFactor)
        Creates a new TCharCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
        Parameters:
        initialCapacity - an int value
        loadFactor - a float value
      • TCharCharHashMap

        public TCharCharHashMap​(int initialCapacity,
                                float loadFactor,
                                char noEntryKey,
                                char noEntryValue)
        Creates a new TCharCharHashMap instance with a prime capacity equal to or greater than initialCapacity and with the specified load factor.
        Parameters:
        initialCapacity - an int value
        loadFactor - a float value
        noEntryKey - a char value that represents null for the Key set.
        noEntryValue - a char value that represents null for the Value set.
      • TCharCharHashMap

        public TCharCharHashMap​(char[] keys,
                                char[] values)
        Creates a new TCharCharHashMap instance containing all of the entries in the map passed in.
        Parameters:
        keys - a char array containing the keys for the matching values.
        values - a char array containing the values.
      • TCharCharHashMap

        public TCharCharHashMap​(TCharCharMap map)
        Creates a new TCharCharHashMap instance containing all of the entries in the map passed in.
        Parameters:
        map - a TCharCharMap that will be duplicated.
    • Method Detail

      • setUp

        protected int setUp​(int initialCapacity)
        initializes the hashtable to a prime capacity which is at least initialCapacity + 1.
        Overrides:
        setUp in class TCharCharHash
        Parameters:
        initialCapacity - an int value
        Returns:
        the actual capacity chosen
      • rehash

        protected void rehash​(int newCapacity)
        Rehashes the set.
        Specified by:
        rehash in class THash
        Parameters:
        newCapacity - an int value
      • put

        public char put​(char key,
                        char value)
        Inserts a key/value pair into the map.
        Specified by:
        put in interface TCharCharMap
        Returns:
        the previous value associated with key, or the "no entry" value if none was found (see TCharCharMap.getNoEntryValue()).
      • putIfAbsent

        public char putIfAbsent​(char key,
                                char value)
        Inserts a key/value pair into the map if the specified key is not already associated with a value.
        Specified by:
        putIfAbsent in interface TCharCharMap
        Returns:
        the previous value associated with key, or the "no entry" value if none was found (see TCharCharMap.getNoEntryValue()).
      • putAll

        public void putAll​(java.util.Map<? extends java.lang.Character,​? extends java.lang.Character> map)
        Put all the entries from the given Map into this map.
        Specified by:
        putAll in interface TCharCharMap
        Parameters:
        map - The Map from which entries will be obtained to put into this map.
      • putAll

        public void putAll​(TCharCharMap map)
        Put all the entries from the given map into this map.
        Specified by:
        putAll in interface TCharCharMap
        Parameters:
        map - The map from which entries will be obtained to put into this map.
      • get

        public char get​(char key)
        Retrieves the value for key.
        Specified by:
        get in interface TCharCharMap
        Returns:
        the previous value associated with key, or the "no entry" value if none was found (see TCharCharMap.getNoEntryValue()).
      • clear

        public void clear()
        Empties the collection.
        Specified by:
        clear in interface TCharCharMap
        Overrides:
        clear in class THash
      • isEmpty

        public boolean isEmpty()
        Tells whether this set is currently holding any elements.
        Specified by:
        isEmpty in interface TCharCharMap
        Overrides:
        isEmpty in class THash
        Returns:
        a boolean value
      • remove

        public char remove​(char key)
        Deletes a key/value pair from the map.
        Specified by:
        remove in interface TCharCharMap
        Parameters:
        key - an char value
        Returns:
        the previous value associated with key, or the "no entry" value if none was found (see TCharCharMap.getNoEntryValue()).
      • removeAt

        protected void removeAt​(int index)
        Releases the element currently stored at index.
        Overrides:
        removeAt in class TCharCharHash
        Parameters:
        index - an int value
      • keySet

        public TCharSet keySet()
        Returns the keys of the map as a TCharSet
        Specified by:
        keySet in interface TCharCharMap
        Returns:
        the keys of the map as a TCharSet
      • keys

        public char[] keys()
        Returns the keys of the map as an array of char values.
        Specified by:
        keys in interface TCharCharMap
        Returns:
        the keys of the map as an array of char values.
      • keys

        public char[] keys​(char[] array)
        Returns the keys of the map.
        Specified by:
        keys in interface TCharCharMap
        Parameters:
        array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.
        Returns:
        the keys of the map as an array.
      • valueCollection

        public TCharCollection valueCollection()
        Returns the values of the map as a TCharCollection
        Specified by:
        valueCollection in interface TCharCharMap
        Returns:
        the values of the map as a TCharCollection
      • values

        public char[] values()
        Returns the values of the map as an array of #e# values.
        Specified by:
        values in interface TCharCharMap
        Returns:
        the values of the map as an array of #e# values.
      • values

        public char[] values​(char[] array)
        Returns the values of the map using an existing array.
        Specified by:
        values in interface TCharCharMap
        Parameters:
        array - the array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same type is allocated for this purpose.
        Returns:
        the values of the map as an array of #e# values.
      • containsValue

        public boolean containsValue​(char val)
        Checks for the presence of val in the values of the map.
        Specified by:
        containsValue in interface TCharCharMap
      • containsKey

        public boolean containsKey​(char key)
        Checks for the present of key in the keys of the map.
        Specified by:
        containsKey in interface TCharCharMap
      • forEachKey

        public boolean forEachKey​(TCharProcedure procedure)
        Executes procedure for each key in the map.
        Specified by:
        forEachKey in interface TCharCharMap
        Parameters:
        procedure - a TCharProcedure value
        Returns:
        false if the loop over the keys terminated because the procedure returned false for some key.
      • forEachValue

        public boolean forEachValue​(TCharProcedure procedure)
        Executes procedure for each value in the map.
        Specified by:
        forEachValue in interface TCharCharMap
        Parameters:
        procedure - a T#F#Procedure value
        Returns:
        false if the loop over the values terminated because the procedure returned false for some value.
      • forEachEntry

        public boolean forEachEntry​(TCharCharProcedure procedure)
        Executes procedure for each key/value entry in the map.
        Specified by:
        forEachEntry in interface TCharCharMap
        Parameters:
        procedure - a TOCharCharProcedure value
        Returns:
        false if the loop over the entries terminated because the procedure returned false for some entry.
      • transformValues

        public void transformValues​(TCharFunction function)
        Transform the values in this map using function.
        Specified by:
        transformValues in interface TCharCharMap
        Parameters:
        function - a TCharFunction value
      • retainEntries

        public boolean retainEntries​(TCharCharProcedure procedure)
        Retains only those entries in the map for which the procedure returns a true value.
        Specified by:
        retainEntries in interface TCharCharMap
        Parameters:
        procedure - determines which entries to keep
        Returns:
        true if the map was modified.
      • increment

        public boolean increment​(char key)
        Increments the primitive value mapped to key by 1
        Specified by:
        increment in interface TCharCharMap
        Parameters:
        key - the key of the value to increment
        Returns:
        true if a mapping was found and modified.
      • adjustValue

        public boolean adjustValue​(char key,
                                   char amount)
        Adjusts the primitive value mapped to key.
        Specified by:
        adjustValue in interface TCharCharMap
        Parameters:
        key - the key of the value to increment
        amount - the amount to adjust the value by.
        Returns:
        true if a mapping was found and modified.
      • adjustOrPutValue

        public char adjustOrPutValue​(char key,
                                     char adjust_amount,
                                     char put_amount)
        Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the put_amount is put in the map.
        Specified by:
        adjustOrPutValue in interface TCharCharMap
        Parameters:
        key - the key of the value to increment
        adjust_amount - the amount to adjust the value by
        put_amount - the value put into the map if the key is not present
        Returns:
        the value present in the map after the adjustment or put operation
      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                           throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Overrides:
        writeExternal in class TCharCharHash
        Throws:
        java.io.IOException
      • readExternal

        public void readExternal​(java.io.ObjectInput in)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Overrides:
        readExternal in class TCharCharHash
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException