gnu.trove.impl.unmodifiable

Class TUnmodifiableCharObjectMap<V>

    • Method Summary

      Modifier and Type Method and Description
      void clear()
      Removes all of the mappings from this map (optional operation).
      boolean containsKey(char key)
      Returns true if this map contains a mapping for the specified key.
      boolean containsValue(Object val)
      Returns true if this map maps one or more keys to the specified value.
      boolean equals(Object o)
      Compares the specified object with this map for equality.
      boolean forEachEntry(TCharObjectProcedure<? super V> 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(TObjectProcedure<? super V> procedure)
      Executes procedure for each value in the map.
      V get(char key)
      Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
      char getNoEntryKey()
      Returns the value that represents null in the TCharObjectMap.keySet().
      int hashCode()
      Returns the hash code value for this map.
      boolean isEmpty()
      Returns true if this map contains no key-value mappings.
      TCharObjectIterator<V> iterator()
      Returns a TCharObjectIterator with access to this map's keys and values.
      char[] keys()
      Returns a copy of the keys of the map as an array.
      char[] keys(char[] array)
      Returns a copy of the keys of the map as an array.
      TCharSet keySet()
      Returns a TCharSet view of the keys contained in this map.
      V put(char key, V value)
      Associates the specified value with the specified key in this map (optional operation).
      void putAll(Map<? extends Character,? extends V> map)
      Copies all of the mappings from the specified map to this map (optional operation).
      void putAll(TCharObjectMap<? extends V> m)
      Put all the entries from the given map into this map.
      V putIfAbsent(char key, V value)
      Inserts a key/value pair into the map if the specified key is not already associated with a value.
      V remove(char key)
      Removes the mapping for a key from this map if it is present (optional operation).
      boolean retainEntries(TCharObjectProcedure<? super V> procedure)
      Retains only those entries in the map for which the procedure returns a true value.
      int size()
      Returns the number of key-value mappings in this map.
      String toString()
       
      void transformValues(TObjectFunction<V,V> function)
      Transform the values in this map using function.
      Collection<V> valueCollection()
      Returns a Collection view of the values contained in this map.
      Object[] values()
      Returns the values of the map as an Object array.
      V[] values(V[] array)
      Returns the values of the map using an existing array.

    • Constructor Detail

      • TUnmodifiableCharObjectMap

        public TUnmodifiableCharObjectMap(TCharObjectMap<V> m)

    • Method Detail

      • size

        public int size()
        Description copied from interface: TCharObjectMap
        Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
        Specified by:
        size in interface  TCharObjectMap<V>
        Returns:
        the number of key-value mappings in this map

      • isEmpty

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

      • containsKey

        public boolean containsKey(char key)
        Description copied from interface: TCharObjectMap
        Returns true if this map contains a mapping for the specified key. More formally, returns true if and only if this map contains a mapping for a key k such that key.equals(k). (There can be at most one such mapping.)
        Specified by:
        containsKey in interface  TCharObjectMap<V>
        Parameters:
        key - key whose presence in this map is to be tested
        Returns:
        true if this map contains a mapping for the specified key

      • containsValue

        public boolean containsValue(Object val)
        Description copied from interface: TCharObjectMap
        Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.
        Specified by:
        containsValue in interface  TCharObjectMap<V>
        Parameters:
        val - value whose presence in this map is to be tested
        Returns:
        true if this map maps one or more keys to the specified value

      • get

        public V get(char key)
        Description copied from interface: TCharObjectMap
        Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

        More formally, if this map contains a mapping from a key k to a value v such that (key==null ? k==null : key.equals(k)), then this method returns v; otherwise it returns null. (There can be at most one such mapping.)

        If this map permits null values, then a return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

        Specified by:
        get in interface  TCharObjectMap<V>
        Parameters:
        key - the key whose associated value is to be returned
        Returns:
        the char value to which the specified key is mapped, or null if this map contains no mapping for the key

      • put

        public V put(char key,
             V value)
        Description copied from interface: TCharObjectMap
        Associates the specified value with the specified key in this map (optional operation). If the map previously contained a mapping for the key, the old value is replaced by the specified value. (A map m is said to contain a mapping for a key k if and only if m.containsKey(k) would return true.)
        Specified by:
        put in interface  TCharObjectMap<V>
        Parameters:
        key - key with which the specified value is to be associated
        value - an char value value to be associated with the specified key
        Returns:
        the previous value associated with key, or no_entry_value if there was no mapping for key. (A no_entry_value return can also indicate that the map previously associated null with key, if the implementation supports null values.)
        See Also:
        TCharObjectMap.getNoEntryKey()

      • remove

        public V remove(char key)
        Description copied from interface: TCharObjectMap
        Removes the mapping for a key from this map if it is present (optional operation). More formally, if this map contains a mapping from key k to value v such that key.equals(k), that mapping is removed. (The map can contain at most one such mapping.)

        Returns the value to which this map previously associated the key, or null if the map contained no mapping for the key.

        If this map permits null values, then a return value of null does not necessarily indicate that the map contained no mapping for the key; it's also possible that the map explicitly mapped the key to null.

        The map will not contain a mapping for the specified key once the call returns.

        Specified by:
        remove in interface  TCharObjectMap<V>
        Parameters:
        key - key whose mapping is to be removed from the map
        Returns:
        the previous char value associated with key, or null if there was no mapping for key.

      • putAll

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

      • putAll

        public void putAll(Map<? extends Character,? extends V> map)
        Description copied from interface: TCharObjectMap
        Copies all of the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.
        Specified by:
        putAll in interface  TCharObjectMap<V>
        Parameters:
        map - mappings to be stored in this map

      • clear

        public void clear()
        Description copied from interface: TCharObjectMap
        Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.

      • keySet

        public TCharSet keySet()
        Description copied from interface: TCharObjectMap
        Returns a TCharSet view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.
        Specified by:
        keySet in interface  TCharObjectMap<V>
        Returns:
        a set view of the keys contained in this map

      • keys

        public char[] keys()
        Description copied from interface: TCharObjectMap
        Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.
        Specified by:
        keys in interface  TCharObjectMap<V>
        Returns:
        a copy of the keys of the map as an array.

      • keys

        public char[] keys(char[] array)
        Description copied from interface: TCharObjectMap
        Returns a copy of the keys of the map as an array. Changes to the array of keys will not be reflected in the map nor vice-versa.
        Specified by:
        keys in interface  TCharObjectMap<V>
        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 Collection<V> valueCollection()
        Description copied from interface: TCharObjectMap
        Returns a Collection view of the values contained in this map. The collection is backed by the map, so changes to the map are reflected in the collection, and vice-versa. If the map is modified while an iteration over the collection is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The collection supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Collection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
        Specified by:
        valueCollection in interface  TCharObjectMap<V>
        Returns:
        a collection view of the values contained in this map

      • values

        public Object[] values()
        Description copied from interface: TCharObjectMap
        Returns the values of the map as an Object array. Note that the array returned is typed as an Object[] and may not be cast to a more specific type. See #values(V[]) for a version which allows specifically typed arrays. Changes to the array of values will not be reflected in the map nor vice-versa.
        Specified by:
        values in interface  TCharObjectMap<V>
        Returns:
        the values of the map as an array of char values.

      • values

        public V[] values(V[] array)
        Description copied from interface: TCharObjectMap
        Returns the values of the map using an existing array. Changes to the array of values will not be reflected in the map nor vice-versa.
        Specified by:
        values in interface  TCharObjectMap<V>
        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 char values.

      • equals

        public boolean equals(Object o)
        Description copied from interface: TCharObjectMap
        Compares the specified object with this map for equality. Returns true if the given object is also a map and the two maps represent the same mappings. More formally, two maps m1 and m2 represent the same mappings if m1.entrySet().equals(m2.entrySet()). This ensures that the equals method works properly across different implementations of the Map interface.
        Specified by:
        equals in interface  TCharObjectMap<V>
        Overrides:
        equals in class  Object
        Parameters:
        o - object to be compared for equality with this map
        Returns:
        true if the specified object is equal to this map

      • hashCode

        public int hashCode()
        Description copied from interface: TCharObjectMap
        Returns the hash code value for this map. The hash code of a map is defined to be the sum of the hash codes of each entry in the map's entrySet() view. This ensures that m1.equals(m2) implies that m1.hashCode()==m2.hashCode() for any two maps m1 and m2, as required by the general contract of Object.hashCode().
        Specified by:
        hashCode in interface  TCharObjectMap<V>
        Overrides:
        hashCode in class  Object
        Returns:
        the hash code value for this map
        See Also:
        Object.equals(Object), TCharObjectMap.equals(Object)

      • toString

        public String toString()

      • getNoEntryKey

        public char getNoEntryKey()
        Description copied from interface: TCharObjectMap
        Returns the value that represents null in the TCharObjectMap.keySet(). The default value is generally zero, but can be changed during construction of the collection.
        Specified by:
        getNoEntryKey in interface  TCharObjectMap<V>
        Returns:
        the value that represents a null value in this collection.

      • forEachKey

        public boolean forEachKey(TCharProcedure procedure)
        Description copied from interface: TCharObjectMap
        Executes procedure for each key in the map.
        Specified by:
        forEachKey in interface  TCharObjectMap<V>
        Parameters:
        procedure - a TObjectProcedure value
        Returns:
        false if the loop over the keys terminated because the procedure returned false for some key.

      • forEachValue

        public boolean forEachValue(TObjectProcedure<? super V> procedure)
        Description copied from interface: TCharObjectMap
        Executes procedure for each value in the map.
        Specified by:
        forEachValue in interface  TCharObjectMap<V>
        Parameters:
        procedure - a TObjectProcedure value
        Returns:
        false if the loop over the values terminated because the procedure returned false for some value.

      • forEachEntry

        public boolean forEachEntry(TCharObjectProcedure<? super V> procedure)
        Description copied from interface: TCharObjectMap
        Executes procedure for each key/value entry in the map.
        Specified by:
        forEachEntry in interface  TCharObjectMap<V>
        Parameters:
        procedure - a TCharObjectProcedure value
        Returns:
        false if the loop over the entries terminated because the procedure returned false for some entry.

      • iterator

        public TCharObjectIterator<V> iterator()
        Description copied from interface: TCharObjectMap
        Returns a TCharObjectIterator with access to this map's keys and values.
        Specified by:
        iterator in interface  TCharObjectMap<V>
        Returns:
        a TCharObjectIterator with access to this map's keys and values.

      • putIfAbsent

        public V putIfAbsent(char key,
                     V value)
        Description copied from interface: TCharObjectMap
        Inserts a key/value pair into the map if the specified key is not already associated with a value.
        Specified by:
        putIfAbsent in interface  TCharObjectMap<V>
        Parameters:
        key - key with which the specified value is to be associated
        value - an char value to be associated with the specified key
        Returns:
        the previous value associated with key, or null if none was found.

      • retainEntries

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