Class ImmutableMultimap<K,V>

    • Nested Class Summary

      Nested Classes

      Modifier and Type Class and Description
      static class  ImmutableMultimap.Builder<K,V>
      A builder for creating immutable multimap instances, especially public static final multimaps ("constant multimaps").
    • Method Summary

      Modifier and Type Method and Description
      ImmutableMap<K,Collection<V>> asMap()
      Returns an immutable map that associates each key with its corresponding values in the multimap.
      static <K,V> ImmutableMultimap.Builder<K,V> builder()
      Returns a new builder.
      void clear()
      Deprecated. 
      Unsupported operation.
      boolean containsEntry(Object key, Object value)
      Returns true if this multimap contains at least one key-value pair with the key key and the value value.
      boolean containsKey(Object key)
      Returns true if this multimap contains at least one key-value pair with the key key.
      boolean containsValue(Object value)
      Returns true if this multimap contains at least one key-value pair with the value value.
      static <K,V> ImmutableMultimap<K,V> copyOf(Iterable<? extends Map.Entry<? extends K,? extends V>> entries)
      Returns an immutable multimap containing the specified entries.
      static <K,V> ImmutableMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap)
      Returns an immutable multimap containing the same mappings as multimap, in the "key-grouped" iteration order described in the class documentation.
      ImmutableCollection<Map.Entry<K,V>> entries()
      Returns an immutable collection of all key-value pairs in the multimap.
      boolean equals(Object object)
      Compares the specified object with this multimap for equality.
      abstract ImmutableCollection<V> get(K key)
      Returns an immutable collection of the values for the given key.
      int hashCode()
      Returns the hash code for this multimap.
      abstract ImmutableMultimap<V,K> inverse()
      Returns an immutable multimap which is the inverse of this one.
      boolean isEmpty()
      Returns true if this multimap contains no key-value pairs.
      ImmutableMultiset<K> keys()
      Returns an immutable multiset containing all the keys in this multimap, in the same order and with the same frequencies as they appear in this multimap; to get only a single occurrence of each key, use keySet().
      ImmutableSet<K> keySet()
      Returns an immutable set of the distinct keys in this multimap, in the same order as they appear in this multimap.
      static <K,V> ImmutableMultimap<K,V> of()
      Returns an empty multimap.
      static <K,V> ImmutableMultimap<K,V> of(K k1, V v1)
      Returns an immutable multimap containing a single entry.
      static <K,V> ImmutableMultimap<K,V> of(K k1, V v1, K k2, V v2)
      Returns an immutable multimap containing the given entries, in order.
      static <K,V> ImmutableMultimap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3)
      Returns an immutable multimap containing the given entries, in the "key-grouped" insertion order described in the class documentation.
      static <K,V> ImmutableMultimap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4)
      Returns an immutable multimap containing the given entries, in the "key-grouped" insertion order described in the class documentation.
      static <K,V> ImmutableMultimap<K,V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5)
      Returns an immutable multimap containing the given entries, in the "key-grouped" insertion order described in the class documentation.
      boolean put(K key, V value)
      Deprecated. 
      Unsupported operation.
      boolean putAll(K key, Iterable<? extends V> values)
      Deprecated. 
      Unsupported operation.
      boolean putAll(Multimap<? extends K,? extends V> multimap)
      Deprecated. 
      Unsupported operation.
      boolean remove(Object key, Object value)
      Deprecated. 
      Unsupported operation.
      ImmutableCollection<V> removeAll(Object key)
      Deprecated. 
      Unsupported operation.
      ImmutableCollection<V> replaceValues(K key, Iterable<? extends V> values)
      Deprecated. 
      Unsupported operation.
      int size()
      Returns the number of key-value pairs in this multimap.
      String toString()
      Returns a string representation of the multimap, generated by calling toString on the map returned by Multimap.asMap().
      ImmutableCollection<V> values()
      Returns an immutable collection of the values in this multimap.
    • Method Detail

      • of

        public static <K,V> ImmutableMultimap<K,V> of(K k1,
                                                      V v1)
        Returns an immutable multimap containing a single entry.
      • of

        public static <K,V> ImmutableMultimap<K,V> of(K k1,
                                                      V v1,
                                                      K k2,
                                                      V v2)
        Returns an immutable multimap containing the given entries, in order.
      • of

        public static <K,V> ImmutableMultimap<K,V> of(K k1,
                                                      V v1,
                                                      K k2,
                                                      V v2,
                                                      K k3,
                                                      V v3)
        Returns an immutable multimap containing the given entries, in the "key-grouped" insertion order described in the class documentation.
      • of

        public static <K,V> ImmutableMultimap<K,V> of(K k1,
                                                      V v1,
                                                      K k2,
                                                      V v2,
                                                      K k3,
                                                      V v3,
                                                      K k4,
                                                      V v4)
        Returns an immutable multimap containing the given entries, in the "key-grouped" insertion order described in the class documentation.
      • of

        public static <K,V> ImmutableMultimap<K,V> of(K k1,
                                                      V v1,
                                                      K k2,
                                                      V v2,
                                                      K k3,
                                                      V v3,
                                                      K k4,
                                                      V v4,
                                                      K k5,
                                                      V v5)
        Returns an immutable multimap containing the given entries, in the "key-grouped" insertion order described in the class documentation.
      • copyOf

        public static <K,V> ImmutableMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap)
        Returns an immutable multimap containing the same mappings as multimap, in the "key-grouped" iteration order described in the class documentation.

        Despite the method name, this method attempts to avoid actually copying the data when it is safe to do so. The exact circumstances under which a copy will or will not be performed are undocumented and subject to change.

        Throws:
        NullPointerException - if any key or value in multimap is null
      • copyOf

        @Beta
        public static <K,V> ImmutableMultimap<K,V> copyOf(Iterable<? extends Map.Entry<? extends K,? extends V>> entries)
        Returns an immutable multimap containing the specified entries. The returned multimap iterates over keys in the order they were first encountered in the input, and the values for each key are iterated in the order they were encountered.
        Throws:
        NullPointerException - if any key, value, or entry is null
        Since:
        19.0
      • removeAll

        @Deprecated
        public ImmutableCollection<V> removeAll(Object key)
        Deprecated.  Unsupported operation.
        Guaranteed to throw an exception and leave the multimap unmodified.
        Specified by:
        removeAll in interface  Multimap<K,V>
        Returns:
        the values that were removed (possibly empty). The returned collection may be modifiable, but updating it will have no effect on the multimap.
        Throws:
        UnsupportedOperationException - always
      • replaceValues

        @Deprecated
        public ImmutableCollection<V> replaceValues(K key,
                                                                Iterable<? extends V> values)
        Deprecated.  Unsupported operation.
        Guaranteed to throw an exception and leave the multimap unmodified.
        Specified by:
        replaceValues in interface  Multimap<K,V>
        Returns:
        the collection of replaced values, or an empty collection if no values were previously associated with the key. The collection may be modifiable, but updating it will have no effect on the multimap.
        Throws:
        UnsupportedOperationException - always
      • get

        public abstract ImmutableCollection<V> get(K key)
        Returns an immutable collection of the values for the given key. If no mappings in the multimap have the provided key, an empty immutable collection is returned. The values are in the same order as the parameters used to build this multimap.
      • inverse

        public abstract ImmutableMultimap<V,K> inverse()
        Returns an immutable multimap which is the inverse of this one. For every key-value mapping in the original, the result will have a mapping with key and value reversed.
        Since:
        11.0
      • put

        @Deprecated
        public boolean put(K key,
                                       V value)
        Deprecated.  Unsupported operation.
        Guaranteed to throw an exception and leave the multimap unmodified.
        Specified by:
        put in interface  Multimap<K,V>
        Returns:
        true if the method increased the size of the multimap, or false if the multimap already contained the key-value pair and doesn't allow duplicates
        Throws:
        UnsupportedOperationException - always
      • containsKey

        public boolean containsKey(Object key)
        Description copied from interface: Multimap
        Returns true if this multimap contains at least one key-value pair with the key key.
      • containsValue

        public boolean containsValue(Object value)
        Description copied from interface: Multimap
        Returns true if this multimap contains at least one key-value pair with the value value.
      • size

        public int size()
        Description copied from interface: Multimap
        Returns the number of key-value pairs in this multimap.

        Note: this method does not return the number of distinct keys in the multimap, which is given by keySet().size() or asMap().size(). See the opening section of the Multimap class documentation for clarification.

      • keySet

        public ImmutableSet<K> keySet()
        Returns an immutable set of the distinct keys in this multimap, in the same order as they appear in this multimap.
      • asMap

        public ImmutableMap<K,Collection<V>> asMap()
        Returns an immutable map that associates each key with its corresponding values in the multimap. Keys and values appear in the same order as in this multimap.
      • keys

        public ImmutableMultiset<K> keys()
        Returns an immutable multiset containing all the keys in this multimap, in the same order and with the same frequencies as they appear in this multimap; to get only a single occurrence of each key, use keySet().
      • values

        public ImmutableCollection<V> values()
        Returns an immutable collection of the values in this multimap. Its iterator traverses the values for the first key, the values for the second key, and so on.
      • isEmpty

        public boolean isEmpty()
        Description copied from interface: Multimap
        Returns true if this multimap contains no key-value pairs. Equivalent to size() == 0, but can in some cases be more efficient.
      • containsEntry

        public boolean containsEntry(Object key,
                                     Object value)
        Description copied from interface: Multimap
        Returns true if this multimap contains at least one key-value pair with the key key and the value value.
      • equals

        public boolean equals(Object object)
        Description copied from interface: Multimap
        Compares the specified object with this multimap for equality. Two multimaps are equal when their map views, as returned by Multimap.asMap(), are also equal.

        In general, two multimaps with identical key-value mappings may or may not be equal, depending on the implementation. For example, two SetMultimap instances with the same key-value mappings are equal, but equality of two ListMultimap instances depends on the ordering of the values for each key.

        A non-empty SetMultimap cannot be equal to a non-empty ListMultimap, since their Multimap.asMap() views contain unequal collections as values. However, any two empty multimaps are equal, because they both have empty Multimap.asMap() views.

      • toString

        public String toString()
        Returns a string representation of the multimap, generated by calling toString on the map returned by Multimap.asMap().
        Overrides:
        toString in class  Object
        Returns:
        a string representation of the multimap