com.google.common.collect

Class ImmutableListMultimap<K,V>

  • All Implemented Interfaces:
    ListMultimap<K,V>, Multimap<K,V>, Serializable 

    @GwtCompatible(serializable=true,
               emulated=true)
public class ImmutableListMultimap<K,V>
extends ImmutableMultimap<K,V>
implements ListMultimap<K,V>
    An immutable ListMultimap with reliable user-specified key and value iteration order. Does not permit null keys or values.

    Unlike Multimaps.unmodifiableListMultimap(ListMultimap), which is a view of a separate multimap which can still change, an instance of ImmutableListMultimap contains its own data and will never change. ImmutableListMultimap is convenient for public static final multimaps ("constant multimaps") and also lets you easily make a "defensive copy" of a multimap provided to your class by a caller.

    Note: Although this class is not final, it cannot be subclassed as it has no public or protected constructors. Thus, instances of this class are guaranteed to be immutable.

    See the Guava User Guide article on immutable collections.

    Since:
    2.0 (imported from Google Collections Library)
    See Also:
    Serialized Form

    • Method Detail

      • of

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

      • of

        public static <K,V> ImmutableListMultimap<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> ImmutableListMultimap<K,V> of(K k1,
                                                  V v1,
                                                  K k2,
                                                  V v2,
                                                  K k3,
                                                  V v3)
        Returns an immutable multimap containing the given entries, in order.

      • of

        public static <K,V> ImmutableListMultimap<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 order.

      • of

        public static <K,V> ImmutableListMultimap<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 order.

      • copyOf

        public static <K,V> ImmutableListMultimap<K,V> copyOf(Multimap<? extends K,? extends V> multimap)
        Returns an immutable multimap containing the same mappings as multimap. The generated multimap's key and value orderings correspond to the iteration ordering of the multimap.asMap() view.

        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

      • get

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

      • inverse

        public ImmutableListMultimap<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.

        Because an inverse of a list multimap can contain multiple pairs with the same key and value, this method returns an ImmutableListMultimap rather than the ImmutableMultimap specified in the ImmutableMultimap class.

        Specified by:
        inverse in class  ImmutableMultimap<K,V>
        Since:
        11.0

      • 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