Skip to content

Document that ImmutableMultimap creation APIs produce ImmutableListMultimap #8261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mvanhorn wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −1
Open

Document that ImmutableMultimap creation APIs produce ImmutableListMultimap #8261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion guava/src/com/google/common/collect/ImmutableMultimap.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ public static <K, V> ImmutableMultimap<K, V> of(
/**
* Returns a new builder. The generated builder is equivalent to the builder created by the {@link
* Builder} constructor.
*
* <p>The returned builder always builds an {@link ImmutableListMultimap}. For clarity and to
* avoid the pitfalls described in the {@linkplain ImmutableMultimap class documentation}, prefer
* {@link ImmutableListMultimap#builder} or {@link ImmutableSetMultimap#builder}.
*/
public static <K, V> Builder<K, V> builder() {
return new Builder<>();
Expand Down Expand Up @@ -360,7 +364,10 @@ Builder<K, V> combine(Builder<K, V> other) {
return this;
}

/** Returns a newly-created immutable multimap. */
/**
* Returns a newly-created immutable multimap. The returned multimap is an {@link
* ImmutableListMultimap}.
*/
public ImmutableMultimap<K, V> build() {
if (builderMap == null) {
return ImmutableListMultimap.of();
Expand Down