Skip to content

Document that ImmutableTable comparators affect ordering, not lookup #8259

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
+14 −2
Open

Document that ImmutableTable comparators affect ordering, not lookup #8259

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
16 changes: 14 additions & 2 deletions guava/src/com/google/common/collect/ImmutableTable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,14 +199,26 @@ public static final class Builder<R, C, V> {
*/
public Builder() {}

/** Specifies the ordering of the generated table's rows. */
/**
* Specifies the ordering of the generated table's rows.
*
* <p>The comparator is used only for ordering. Row lookups in the resulting table, including
* {@link ImmutableTable#row} and {@link ImmutableTable#rowMap}, still use {@link
* Object#equals}.
*/
@CanIgnoreReturnValue
public Builder<R, C, V> orderRowsBy(Comparator<? super R> rowComparator) {
this.rowComparator = checkNotNull(rowComparator, "rowComparator");
return this;
}

/** Specifies the ordering of the generated table's columns. */
/**
* Specifies the ordering of the generated table's columns.
*
* <p>The comparator is used only for ordering. Column lookups in the resulting table, including
* {@link ImmutableTable#column} and {@link ImmutableTable#columnMap}, still use {@link
* Object#equals}.
*/
@CanIgnoreReturnValue
public Builder<R, C, V> orderColumnsBy(Comparator<? super C> columnComparator) {
this.columnComparator = checkNotNull(columnComparator, "columnComparator");
Expand Down