Package gnu.trove.impl.unmodifiable

Class TUnmodifiableCharCharMap

  • All Implemented Interfaces:
    TCharCharMap, java.io.Serializable
    public class TUnmodifiableCharCharMap
extends java.lang.Object
implements TCharCharMap, java.io.Serializable
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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.
      boolean adjustValue​(char key, char amount)
      Adjusts the primitive value mapped to key.
      void clear()
      Empties the map.
      boolean containsKey​(char key)
      Checks for the present of key in the keys of the map.
      boolean containsValue​(char val)
      Checks for the presence of val in the values of the map.
      boolean equals​(java.lang.Object o)  
      boolean forEachEntry​(TCharCharProcedure procedure)
      Executes procedure for each key/value entry in the map.
      boolean forEachKey​(TCharProcedure procedure)
      Executes procedure for each key in the map.
      boolean forEachValue​(TCharProcedure procedure)
      Executes procedure for each value in the map.
      char get​(char key)
      Retrieves the value for key.
      char getNoEntryKey()
      Returns the value that will be returned from TCharCharMap.get(char) or TCharCharMap.put(char, char) if no entry exists for a given key.
      char getNoEntryValue()
      Returns the value that will be returned from TCharCharMap.get(char) or TCharCharMap.put(char, char) if no entry exists for a given key.
      int hashCode()  
      boolean increment​(char key)
      Increments the primitive value mapped to key by 1
      boolean isEmpty()
      Returns true if this map contains no key-value mappings.
      TCharCharIterator iterator()  
      char[] keys()
      Returns the keys of the map as an array of char values.
      char[] keys​(char[] array)
      Returns the keys of the map.
      TCharSet keySet()
      Returns the keys of the map as a TCharSet
      char put​(char key, char value)
      Inserts a key/value pair into the map.
      void putAll​(TCharCharMap m)
      Put all the entries from the given map into this map.
      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.
      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.
      char remove​(char key)
      Deletes a key/value pair from the map.
      boolean retainEntries​(TCharCharProcedure procedure)
      Retains only those entries in the map for which the procedure returns a true value.
      int size()
      Returns an int value that is the number of elements in the map.
      java.lang.String toString()  
      void transformValues​(TCharFunction function)
      Transform the values in this map using function.
      TCharCollection valueCollection()
      Returns the values of the map as a TCharCollection
      char[] values()
      Returns the values of the map as an array of #e# values.
      char[] values​(char[] array)
      Returns the values of the map using an existing array.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • TUnmodifiableCharCharMap

        public TUnmodifiableCharCharMap​(TCharCharMap m)

    • Method Detail

      • size

        public int size()
        Description copied from interface: TCharCharMap
        Returns an int value that is the number of elements in the map.
        Specified by:
        size in interface TCharCharMap
        Returns:
        an int value that is the number of elements in the map.

      • isEmpty

        public boolean isEmpty()
        Description copied from interface: TCharCharMap
        Returns true if this map contains no key-value mappings.
        Specified by:
        isEmpty in interface TCharCharMap
        Returns:
        true if this map contains no key-value mappings

      • containsKey

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

      • containsValue

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

      • get

        public char get​(char key)
        Description copied from interface: TCharCharMap
        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()).

      • put

        public char put​(char key,
                char value)
        Description copied from interface: TCharCharMap
        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()).

      • remove

        public char remove​(char key)
        Description copied from interface: TCharCharMap
        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()).

      • putAll

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

      • putAll

        public void putAll​(java.util.Map<? extends java.lang.Character,​? extends java.lang.Character> map)
        Description copied from interface: TCharCharMap
        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.

      • keySet

        public TCharSet keySet()
        Description copied from interface: TCharCharMap
        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()
        Description copied from interface: TCharCharMap
        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)
        Description copied from interface: TCharCharMap
        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()
        Description copied from interface: TCharCharMap
        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()
        Description copied from interface: TCharCharMap
        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)
        Description copied from interface: TCharCharMap
        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.

      • equals

        public boolean equals​(java.lang.Object o)
        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

      • getNoEntryKey

        public char getNoEntryKey()
        Description copied from interface: TCharCharMap
        Returns the value that will be returned from TCharCharMap.get(char) or TCharCharMap.put(char, char) if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.
        Specified by:
        getNoEntryKey in interface TCharCharMap
        Returns:
        the value that represents a null key in this collection.

      • getNoEntryValue

        public char getNoEntryValue()
        Description copied from interface: TCharCharMap
        Returns the value that will be returned from TCharCharMap.get(char) or TCharCharMap.put(char, char) if no entry exists for a given key. The default value is generally zero, but can be configured during construction of the collection.
        Specified by:
        getNoEntryValue in interface TCharCharMap
        Returns:
        the value that represents a null value in this collection.

      • forEachKey

        public boolean forEachKey​(TCharProcedure procedure)
        Description copied from interface: TCharCharMap
        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)
        Description copied from interface: TCharCharMap
        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)
        Description copied from interface: TCharCharMap
        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.

      • putIfAbsent

        public char putIfAbsent​(char key,
                        char value)
        Description copied from interface: TCharCharMap
        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()).

      • transformValues

        public void transformValues​(TCharFunction function)
        Description copied from interface: TCharCharMap
        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)
        Description copied from interface: TCharCharMap
        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)
        Description copied from interface: TCharCharMap
        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)
        Description copied from interface: TCharCharMap
        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)
        Description copied from interface: TCharCharMap
        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