Class TUnmodifiableObjectCharMap<K>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      char adjustOrPutValue​(K key, char adjust_amount, char put_amount)
      Adds an amount to the primitive value mapped to the key if the key is present in the map.
      boolean adjustValue​(K key, char amount)
      Adds an amount to the primitive value mapped to key.
      void clear()
      Removes all of the mappings from this map (optional operation).
      boolean containsKey​(java.lang.Object 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)
      Compares the specified object with this map for equality.
      boolean forEachEntry​(TObjectCharProcedure<? super K> procedure)
      Executes procedure for each key/value entry in the map.
      boolean forEachKey​(TObjectProcedure<? super K> procedure)
      Executes procedure for each key in the map.
      boolean forEachValue​(TCharProcedure procedure)
      Executes procedure for each value in the map.
      char get​(java.lang.Object key)
      Retrieves the value for key.
      char getNoEntryValue()
      Returns the value that will be returned from TObjectCharMap.get(java.lang.Object) or TObjectCharMap.put(K, char) if no entry exists for a given key.
      int hashCode()
      Returns the hash code value for this map.
      boolean increment​(K key)
      Increments the primitive value mapped to key by 1
      boolean isEmpty()
      Returns true if this map contains no key-value mappings.
      TObjectCharIterator<K> iterator()
      Returns a TObjectCharIterator with access to this map's keys and values.
      java.lang.Object[] keys()
      Returns a copy of the keys of the map as an array.
      K[] keys​(K[] array)
      Returns a copy of the keys of the map as an array.
      java.util.Set<K> keySet()
      Returns a Set view of the keys contained in this map.
      char put​(K key, char value)
      Inserts a key/value pair into the map.
      void putAll​(TObjectCharMap<? extends K> m)
      Put all the entries from the given map into this map.
      void putAll​(java.util.Map<? extends K,​? extends java.lang.Character> map)
      Copies all of the mappings from the specified map to this map (optional operation).
      char putIfAbsent​(K key, char value)
      Inserts a key/value pair into the map if the specified key is not already associated with a value.
      char remove​(java.lang.Object key)
      Deletes a key/value pair from the map.
      boolean retainEntries​(TObjectCharProcedure<? super K> 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.
      java.lang.String toString()  
      void transformValues​(TCharFunction function)
      Transform the values in this map using function.
      TCharCollection valueCollection()
      Returns a TCharCollection view of the values contained in this map.
      char[] values()
      Returns the values of the map as an array of char 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

      • TUnmodifiableObjectCharMap

        public TUnmodifiableObjectCharMap​(TObjectCharMap<K> m)
    • Method Detail

      • size

        public int size()
        Description copied from interface: TObjectCharMap
        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 TObjectCharMap<K>
        Returns:
        the number of key-value mappings in this map
      • isEmpty

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

        public boolean containsKey​(java.lang.Object key)
        Description copied from interface: TObjectCharMap
        Checks for the present of key in the keys of the map.
        Specified by:
        containsKey in interface TObjectCharMap<K>
      • containsValue

        public boolean containsValue​(char val)
        Description copied from interface: TObjectCharMap
        Checks for the presence of val in the values of the map.
        Specified by:
        containsValue in interface TObjectCharMap<K>
      • remove

        public char remove​(java.lang.Object key)
        Description copied from interface: TObjectCharMap
        Deletes a key/value pair from the map.
        Specified by:
        remove in interface TObjectCharMap<K>
        Parameters:
        key - an #k# value
        Returns:
        the previous value associated with key, or the "no entry" value if none was found (see TObjectCharMap.getNoEntryValue()).
      • putAll

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

        public void putAll​(java.util.Map<? extends K,​? extends java.lang.Character> map)
        Description copied from interface: TObjectCharMap
        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 TObjectCharMap<K>
        Parameters:
        map - mappings to be stored in this map
      • clear

        public void clear()
        Description copied from interface: TObjectCharMap
        Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
        Specified by:
        clear in interface TObjectCharMap<K>
      • keySet

        public java.util.Set<K> keySet()
        Description copied from interface: TObjectCharMap
        Returns a Set 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 TObjectCharMap<K>
        Returns:
        a set view of the keys contained in this map
      • keys

        public java.lang.Object[] keys()
        Description copied from interface: TObjectCharMap
        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 TObjectCharMap<K>
        Returns:
        a copy of the keys of the map as an array.
      • keys

        public K[] keys​(K[] array)
        Description copied from interface: TObjectCharMap
        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 TObjectCharMap<K>
        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: TObjectCharMap
        Returns a TCharCollection 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 TCharIterator.remove, TCharCollection.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
        Specified by:
        valueCollection in interface TObjectCharMap<K>
        Returns:
        a collection view of the values contained in this map
      • values

        public char[] values()
        Description copied from interface: TObjectCharMap
        Returns the values of the map as an array of char values. Changes to the array of values will not be reflected in the map nor vice-versa.
        Specified by:
        values in interface TObjectCharMap<K>
        Returns:
        the values of the map as an array of char values.
      • values

        public char[] values​(char[] array)
        Description copied from interface: TObjectCharMap
        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 TObjectCharMap<K>
        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​(java.lang.Object o)
        Description copied from interface: TObjectCharMap
        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 TObjectCharMap<K>
        Overrides:
        equals in class java.lang.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: TObjectCharMap
        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 TObjectCharMap<K>
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hash code value for this map
        See Also:
        Object.equals(Object), TObjectCharMap.equals(Object)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • forEachKey

        public boolean forEachKey​(TObjectProcedure<? super K> procedure)
        Description copied from interface: TObjectCharMap
        Executes procedure for each key in the map.
        Specified by:
        forEachKey in interface TObjectCharMap<K>
        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​(TCharProcedure procedure)
        Description copied from interface: TObjectCharMap
        Executes procedure for each value in the map.
        Specified by:
        forEachValue in interface TObjectCharMap<K>
        Parameters:
        procedure - a TCharProcedure value
        Returns:
        false if the loop over the values terminated because the procedure returned false for some value.
      • forEachEntry

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

        public TObjectCharIterator<K> iterator()
        Description copied from interface: TObjectCharMap
        Returns a TObjectCharIterator with access to this map's keys and values.
        Specified by:
        iterator in interface TObjectCharMap<K>
        Returns:
        a TObjectCharIterator with access to this map's keys and values.
      • putIfAbsent

        public char putIfAbsent​(K key,
                                char value)
        Description copied from interface: TObjectCharMap
        Inserts a key/value pair into the map if the specified key is not already associated with a value.
        Specified by:
        putIfAbsent in interface TObjectCharMap<K>
        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 the "no entry" value if none was found (see TObjectCharMap.getNoEntryValue()).
      • retainEntries

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

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

        public boolean adjustValue​(K key,
                                   char amount)
        Description copied from interface: TObjectCharMap
        Adds an amount to the primitive value mapped to key. If the key does not exist, the map is not modified (key-value is not inserted).
        Specified by:
        adjustValue in interface TObjectCharMap<K>
        Parameters:
        key - the key of the value to increment
        amount - the amount to add to the value; may be positive, zero, or negative
        Returns:
        true if a mapping was found and modified
        See Also:
        TObjectCharMap.adjustOrPutValue(Object, char, char)
      • adjustOrPutValue

        public char adjustOrPutValue​(K key,
                                     char adjust_amount,
                                     char put_amount)
        Description copied from interface: TObjectCharMap
        Adds an amount to 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 TObjectCharMap<K>
        Parameters:
        key - the key of the value to increment
        adjust_amount - the amount to add to the value; may be positive, zero, or negative
        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