Package gnu.trove.impl.unmodifiable

Class TUnmodifiableCharIntMap

java.lang.Object
gnu.trove.impl.unmodifiable.TUnmodifiableCharIntMap
All Implemented Interfaces:
TCharIntMap, Serializable
public class TUnmodifiableCharIntMap extends Object implements TCharIntMap, Serializable
See Also:

  • Constructor Details

    • TUnmodifiableCharIntMap

      public TUnmodifiableCharIntMap(TCharIntMap m)

  • Method Details

    • size

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

    • isEmpty

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

    • containsKey

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

    • containsValue

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

    • get

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

    • put

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

    • remove

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

    • putAll

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

    • putAll

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

    • clear

      public void clear()
      Description copied from interface: TCharIntMap
      Empties the map.
      Specified by:
      clear in interface TCharIntMap

    • keySet

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

    • keys

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

    • keys

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

    • values

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

    • values

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getNoEntryKey

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

    • getNoEntryValue

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

    • forEachKey

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

    • iterator

      public TCharIntIterator iterator()
      Specified by:
      iterator in interface TCharIntMap
      Returns:
      a TCharIntIterator with access to this map's keys and values

    • putIfAbsent

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

    • transformValues

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

    • retainEntries

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

    • increment

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

    • adjustValue

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