Interface Object2ObjectMap<K,​V>

    • Method Detail

      • size

        int size()
        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 Function<K,​V>
        Specified by:
        size in interface Map<K,​V>
        Returns:
        the number of key-value mappings in this map.
        See Also:
        Size64
      • clear

        default void clear()
        Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
        Specified by:
        clear in interface Function<K,​V>
        Specified by:
        clear in interface Map<K,​V>
        Throws:
        UnsupportedOperationException - if the clear() operation is not supported by this map
        See Also:
        Map.clear()
      • defaultReturnValue

        void defaultReturnValue​(V rv)
        Sets the default return value (optional operation). This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be null by default.

        Warning: Changing this to a non-null value can have unforeseen consequences. Especially, it breaks compatibility with the specifications of Java's Map interface. It has to be used with great care and thorough study of all method comments is recommended.

        Specified by:
        defaultReturnValue in interface Object2ObjectFunction<K,​V>
        Parameters:
        rv - the new default return value.
        See Also:
        defaultReturnValue()
      • object2ObjectEntrySet

        ObjectSet<Object2ObjectMap.Entry<K,​V>> object2ObjectEntrySet()
        Returns a type-specific set view of the mappings contained in this map.

        This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Map.entrySet() so that it returns an ObjectSet of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).

        Returns:
        a type-specific set view of the mappings contained in this map.
        See Also:
        Map.entrySet()
      • entrySet

        default ObjectSet<Map.Entry<K,​V>> entrySet()
        Returns a set view of the mappings contained in this map.

        Note that this specification strengthens the one given in Map.entrySet().

        Specified by:
        entrySet in interface Map<K,​V>
        Returns:
        a set view of the mappings contained in this map.
        See Also:
        Map.entrySet()
      • put

        default V put​(K key,
                      V value)
        Adds a pair to the map (optional operation).

        This default implementation just delegates to the corresponding function method.

        Specified by:
        put in interface Function<K,​V>
        Specified by:
        put in interface Map<K,​V>
        Specified by:
        put in interface Object2ObjectFunction<K,​V>
        Parameters:
        key - the key.
        value - the value.
        Returns:
        the old value, or the default return value if no value was present for the given key.
        See Also:
        Function.put(Object,Object)
      • keySet

        ObjectSet<K> keySet()

        Note that this specification strengthens the one given in Map.keySet().

        Specified by:
        keySet in interface Map<K,​V>
        Returns:
        a set view of the keys contained in this map.
        See Also:
        Map.keySet()
      • containsKey

        boolean containsKey​(Object key)
        Returns true if this function contains a mapping for the specified key.
        Specified by:
        containsKey in interface Function<K,​V>
        Specified by:
        containsKey in interface Map<K,​V>
        Parameters:
        key - the key.
        Returns:
        true if this function associates a value to key.
        See Also:
        Map.containsKey(Object)