Package gnu.trove.impl.unmodifiable

Class TUnmodifiableCharByteMap

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte adjustOrPutValue​(char key, byte adjust_amount, byte put_amount)
      Adjusts the primitive value mapped to the key if the key is present in the map.
      boolean adjustValue​(char key, byte 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​(byte val)
      Checks for the presence of val in the values of the map.
      boolean equals​(java.lang.Object o)  
      boolean forEachEntry​(TCharByteProcedure 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​(TByteProcedure procedure)
      Executes procedure for each value in the map.
      byte get​(char key)
      Retrieves the value for key.
      char getNoEntryKey()
      Returns the value that will be returned from TCharByteMap.get(char) or TCharByteMap.put(char, byte) if no entry exists for a given key.
      byte getNoEntryValue()
      Returns the value that will be returned from TCharByteMap.get(char) or TCharByteMap.put(char, byte) 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.
      TCharByteIterator 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
      byte put​(char key, byte value)
      Inserts a key/value pair into the map.
      void putAll​(TCharByteMap m)
      Put all the entries from the given map into this map.
      void putAll​(java.util.Map<? extends java.lang.Character,​? extends java.lang.Byte> map)
      Put all the entries from the given Map into this map.
      byte putIfAbsent​(char key, byte value)
      Inserts a key/value pair into the map if the specified key is not already associated with a value.
      byte remove​(char key)
      Deletes a key/value pair from the map.
      boolean retainEntries​(TCharByteProcedure 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​(TByteFunction function)
      Transform the values in this map using function.
      TByteCollection valueCollection()
      Returns the values of the map as a TByteCollection
      byte[] values()
      Returns the values of the map as an array of #e# values.
      byte[] values​(byte[] 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

      • TUnmodifiableCharByteMap

        public TUnmodifiableCharByteMap​(TCharByteMap m)

    • Method Detail

      • size

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

      • isEmpty

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

      • containsKey

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

      • containsValue

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

      • get

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

      • put

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

      • remove

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

      • putAll

        public void putAll​(TCharByteMap m)
        Description copied from interface: TCharByteMap
        Put all the entries from the given map into this map.
        Specified by:
        putAll in interface TCharByteMap
        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.Byte> map)
        Description copied from interface: TCharByteMap
        Put all the entries from the given Map into this map.
        Specified by:
        putAll in interface TCharByteMap
        Parameters:
        map - The Map from which entries will be obtained to put into this map.

      • keySet

        public TCharSet keySet()
        Description copied from interface: TCharByteMap
        Returns the keys of the map as a TCharSet
        Specified by:
        keySet in interface TCharByteMap
        Returns:
        the keys of the map as a TCharSet

      • keys

        public char[] keys()
        Description copied from interface: TCharByteMap
        Returns the keys of the map as an array of char values.
        Specified by:
        keys in interface TCharByteMap
        Returns:
        the keys of the map as an array of char values.

      • keys

        public char[] keys​(char[] array)
        Description copied from interface: TCharByteMap
        Returns the keys of the map.
        Specified by:
        keys in interface TCharByteMap
        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 TByteCollection valueCollection()
        Description copied from interface: TCharByteMap
        Returns the values of the map as a TByteCollection
        Specified by:
        valueCollection in interface TCharByteMap
        Returns:
        the values of the map as a TByteCollection

      • values

        public byte[] values()
        Description copied from interface: TCharByteMap
        Returns the values of the map as an array of #e# values.
        Specified by:
        values in interface TCharByteMap
        Returns:
        the values of the map as an array of #e# values.

      • values

        public byte[] values​(byte[] array)
        Description copied from interface: TCharByteMap
        Returns the values of the map using an existing array.
        Specified by:
        values in interface TCharByteMap
        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: TCharByteMap
        Returns the value that will be returned from TCharByteMap.get(char) or TCharByteMap.put(char, byte) 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 TCharByteMap
        Returns:
        the value that represents a null key in this collection.

      • getNoEntryValue

        public byte getNoEntryValue()
        Description copied from interface: TCharByteMap
        Returns the value that will be returned from TCharByteMap.get(char) or TCharByteMap.put(char, byte) 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 TCharByteMap
        Returns:
        the value that represents a null value in this collection.

      • forEachKey

        public boolean forEachKey​(TCharProcedure procedure)
        Description copied from interface: TCharByteMap
        Executes procedure for each key in the map.
        Specified by:
        forEachKey in interface TCharByteMap
        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​(TByteProcedure procedure)
        Description copied from interface: TCharByteMap
        Executes procedure for each value in the map.
        Specified by:
        forEachValue in interface TCharByteMap
        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​(TCharByteProcedure procedure)
        Description copied from interface: TCharByteMap
        Executes procedure for each key/value entry in the map.
        Specified by:
        forEachEntry in interface TCharByteMap
        Parameters:
        procedure - a TOCharByteProcedure value
        Returns:
        false if the loop over the entries terminated because the procedure returned false for some entry.

      • putIfAbsent

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

      • transformValues

        public void transformValues​(TByteFunction function)
        Description copied from interface: TCharByteMap
        Transform the values in this map using function.
        Specified by:
        transformValues in interface TCharByteMap
        Parameters:
        function - a TByteFunction value

      • retainEntries

        public boolean retainEntries​(TCharByteProcedure procedure)
        Description copied from interface: TCharByteMap
        Retains only those entries in the map for which the procedure returns a true value.
        Specified by:
        retainEntries in interface TCharByteMap
        Parameters:
        procedure - determines which entries to keep
        Returns:
        true if the map was modified.

      • increment

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

      • adjustValue

        public boolean adjustValue​(char key,
                           byte amount)
        Description copied from interface: TCharByteMap
        Adjusts the primitive value mapped to key.
        Specified by:
        adjustValue in interface TCharByteMap
        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 byte adjustOrPutValue​(char key,
                             byte adjust_amount,
                             byte put_amount)
        Description copied from interface: TCharByteMap
        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 TCharByteMap
        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