gnu.trove.impl.unmodifiable

Class TUnmodifiableByteCharMap

    • Method Summary

      Modifier and Type Method and Description
      char adjustOrPutValue(byte 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(byte key, char amount)
      Adjusts the primitive value mapped to key.
      void clear()
      Empties the map.
      boolean containsKey(byte 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(Object o)
       
      boolean forEachEntry(TByteCharProcedure procedure)
      Executes procedure for each key/value entry in the map.
      boolean forEachKey(TByteProcedure procedure)
      Executes procedure for each key in the map.
      boolean forEachValue(TCharProcedure procedure)
      Executes procedure for each value in the map.
      char get(byte key)
      Retrieves the value for key
      byte getNoEntryKey()
      Returns the value that will be returned from TByteCharMap.get(byte) or TByteCharMap.put(byte, char) if no entry exists for a given key.
      char getNoEntryValue()
      Returns the value that will be returned from TByteCharMap.get(byte) or TByteCharMap.put(byte, char) if no entry exists for a given key.
      int hashCode()
       
      boolean increment(byte key)
      Increments the primitive value mapped to key by 1
      boolean isEmpty()
      Returns true if this map contains no key-value mappings.
      TByteCharIterator iterator()
       
      byte[] keys()
      Returns the keys of the map as an array of byte values.
      byte[] keys(byte[] array)
      Returns the keys of the map.
      TByteSet keySet()
      Returns the keys of the map as a TByteSet
      char put(byte key, char value)
      Inserts a key/value pair into the map.
      void putAll(Map<? extends Byte,? extends Character> map)
      Put all the entries from the given Map into this map.
      void putAll(TByteCharMap m)
      Put all the entries from the given map into this map.
      char putIfAbsent(byte key, char value)
      Inserts a key/value pair into the map if the specified key is not already associated with a value.
      char remove(byte key)
      Deletes a key/value pair from the map.
      boolean retainEntries(TByteCharProcedure 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.
      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.

    • Constructor Detail

      • TUnmodifiableByteCharMap

        public TUnmodifiableByteCharMap(TByteCharMap m)

    • Method Detail

      • size

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

      • isEmpty

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

      • containsKey

        public boolean containsKey(byte key)
        Description copied from interface: TByteCharMap
        Checks for the present of key in the keys of the map.
        Specified by:
        containsKey in interface  TByteCharMap
        Parameters:
        key - an byte value
        Returns:
        a boolean value

      • containsValue

        public boolean containsValue(char val)
        Description copied from interface: TByteCharMap
        Checks for the presence of val in the values of the map.
        Specified by:
        containsValue in interface  TByteCharMap
        Parameters:
        val - an char value
        Returns:
        a boolean value

      • get

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

      • put

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

      • remove

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

      • putAll

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

      • putAll

        public void putAll(Map<? extends Byte,? extends Character> map)
        Description copied from interface: TByteCharMap
        Put all the entries from the given Map into this map.
        Specified by:
        putAll in interface  TByteCharMap
        Parameters:
        map - The Map from which entries will be obtained to put into this map.

      • clear

        public void clear()
        Description copied from interface: TByteCharMap
        Empties the map.

      • keySet

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

      • keys

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

      • keys

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

      • values

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

      • values

        public char[] values(char[] array)
        Description copied from interface: TByteCharMap
        Returns the values of the map using an existing array.
        Specified by:
        values in interface  TByteCharMap
        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(Object o)

      • hashCode

        public int hashCode()

      • toString

        public String toString()

      • getNoEntryKey

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

      • getNoEntryValue

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

      • forEachKey

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

      • putIfAbsent

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

      • transformValues

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

      • retainEntries

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

      • increment

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

      • adjustValue

        public boolean adjustValue(byte key,
                           char amount)
        Description copied from interface: TByteCharMap
        Adjusts the primitive value mapped to key.
        Specified by:
        adjustValue in interface  TByteCharMap
        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(byte key,
                             char adjust_amount,
                             char put_amount)
        Description copied from interface: TByteCharMap
        Adjusts the primitive value mapped to the key if the key is present in the map. Otherwise, the initial_value is put in the map.
        Specified by:
        adjustOrPutValue in interface  TByteCharMap
        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 initial present
        Returns:
        the value present in the map after the adjustment or put operation