Class ImmutableTable<R,C,V>
- java.lang.Object
-
- com.google.common.collect.ImmutableTable<R,C,V>
-
- All Implemented Interfaces:
Table<R,C,V>
,java.io.Serializable
@GwtCompatible public abstract class ImmutableTable<R,C,V> extends java.lang.Object implements java.io.Serializable
ATable
whose contents will never change, with many other important properties detailed atImmutableCollection
.See the Guava User Guide article on immutable collections.
- Since:
- 11.0
- Author:
- Gregory Kick
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableTable.Builder<R,C,V>
A builder for creating immutable table instances, especiallypublic static final
tables ("constant tables").
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <R,C,V>
ImmutableTable.Builder<R,C,V>builder()
Returns a new builder.ImmutableSet<Table.Cell<R,C,V>>
cellSet()
Returns a set of all row key / column key / value triplets.void
clear()
Deprecated.Unsupported operation.ImmutableMap<R,V>
column(C columnKey)
Returns a view of all mappings that have the given column key.ImmutableSet<C>
columnKeySet()
Returns a set of column keys that have one or more values in the table.abstract ImmutableMap<C,java.util.Map<R,V>>
columnMap()
Returns a view that associates each column key with the corresponding map from row keys to values.boolean
contains(java.lang.Object rowKey, java.lang.Object columnKey)
Returnstrue
if the table contains a mapping with the specified row and column keys.boolean
containsColumn(java.lang.Object columnKey)
Returnstrue
if the table contains a mapping with the specified column.boolean
containsRow(java.lang.Object rowKey)
Returnstrue
if the table contains a mapping with the specified row key.boolean
containsValue(java.lang.Object value)
Returnstrue
if the table contains a mapping with the specified value.static <R,C,V>
ImmutableTable<R,C,V>copyOf(Table<? extends R,? extends C,? extends V> table)
Returns an immutable copy of the provided table.boolean
equals(java.lang.Object obj)
Compares the specified object with this table for equality.V
get(java.lang.Object rowKey, java.lang.Object columnKey)
Returns the value corresponding to the given row and column keys, ornull
if no such mapping exists.int
hashCode()
Returns the hash code for this table.boolean
isEmpty()
Returnstrue
if the table contains no mappings.static <R,C,V>
ImmutableTable<R,C,V>of()
Returns an empty immutable table.static <R,C,V>
ImmutableTable<R,C,V>of(R rowKey, C columnKey, V value)
Returns an immutable table containing a single cell.V
put(R rowKey, C columnKey, V value)
Deprecated.Unsupported operation.void
putAll(Table<? extends R,? extends C,? extends V> table)
Deprecated.Unsupported operation.V
remove(java.lang.Object rowKey, java.lang.Object columnKey)
Deprecated.Unsupported operation.ImmutableMap<C,V>
row(R rowKey)
Returns a view of all mappings that have the given row key.ImmutableSet<R>
rowKeySet()
Returns a set of row keys that have one or more values in the table.abstract ImmutableMap<R,java.util.Map<C,V>>
rowMap()
Returns a view that associates each row key with the corresponding map from column keys to values.static <T extends @Nullable java.lang.Object,R,C,V>
java.util.stream.Collector<T,?,ImmutableTable<R,C,V>>toImmutableTable(java.util.function.Function<? super T,? extends R> rowFunction, java.util.function.Function<? super T,? extends C> columnFunction, java.util.function.Function<? super T,? extends V> valueFunction)
Returns aCollector
that accumulates elements into anImmutableTable
.static <T extends @Nullable java.lang.Object,R,C,V>
java.util.stream.Collector<T,?,ImmutableTable<R,C,V>>toImmutableTable(java.util.function.Function<? super T,? extends R> rowFunction, java.util.function.Function<? super T,? extends C> columnFunction, java.util.function.Function<? super T,? extends V> valueFunction, java.util.function.BinaryOperator<V> mergeFunction)
Returns aCollector
that accumulates elements into anImmutableTable
.java.lang.String
toString()
Returns the string representationrowMap().toString()
.ImmutableCollection<V>
values()
Returns a collection of all values, which may contain duplicates.
-
-
-
Method Detail
-
toImmutableTable
public static <T extends @Nullable java.lang.Object,R,C,V> java.util.stream.Collector<T,?,ImmutableTable<R,C,V>> toImmutableTable(java.util.function.Function<? super T,? extends R> rowFunction, java.util.function.Function<? super T,? extends C> columnFunction, java.util.function.Function<? super T,? extends V> valueFunction)
Returns aCollector
that accumulates elements into anImmutableTable
. Each input element is mapped to one cell in the returned table, with the rows, columns, and values generated by applying the specified functions.The returned
Collector
will throw aNullPointerException
at collection time if the row, column, or value functions return null on any input.- Since:
- 33.2.0 (available since 21.0 in guava-jre)
-
toImmutableTable
public static <T extends @Nullable java.lang.Object,R,C,V> java.util.stream.Collector<T,?,ImmutableTable<R,C,V>> toImmutableTable(java.util.function.Function<? super T,? extends R> rowFunction, java.util.function.Function<? super T,? extends C> columnFunction, java.util.function.Function<? super T,? extends V> valueFunction, java.util.function.BinaryOperator<V> mergeFunction)
Returns aCollector
that accumulates elements into anImmutableTable
. Each input element is mapped to one cell in the returned table, with the rows, columns, and values generated by applying the specified functions. If multiple inputs are mapped to the same row and column pair, they will be combined with the specified merging function in encounter order.The returned
Collector
will throw aNullPointerException
at collection time if the row, column, value, or merging functions return null on any input.- Since:
- 33.2.0 (available since 21.0 in guava-jre)
-
of
public static <R,C,V> ImmutableTable<R,C,V> of()
Returns an empty immutable table.Performance note: the instance returned is a singleton.
-
of
public static <R,C,V> ImmutableTable<R,C,V> of(R rowKey, C columnKey, V value)
Returns an immutable table containing a single cell.
-
copyOf
public static <R,C,V> ImmutableTable<R,C,V> copyOf(Table<? extends R,? extends C,? extends V> table)
Returns an immutable copy of the provided table.The
Table.cellSet()
iteration order of the provided table determines the iteration ordering of all views in the returned table. Note that some views of the original table and the copied table may have different iteration orders. For more control over the ordering, create aImmutableTable.Builder
and callImmutableTable.Builder.orderRowsBy(java.util.Comparator<? super R>)
,ImmutableTable.Builder.orderColumnsBy(java.util.Comparator<? super C>)
, andImmutableTable.Builder.putAll(com.google.common.collect.Table<? extends R, ? extends C, ? extends V>)
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.
-
builder
public static <R,C,V> ImmutableTable.Builder<R,C,V> builder()
Returns a new builder. The generated builder is equivalent to the builder created by theImmutableTable.Builder()
constructor.
-
cellSet
public ImmutableSet<Table.Cell<R,C,V>> cellSet()
Description copied from interface:Table
Returns a set of all row key / column key / value triplets. Changes to the returned set will update the underlying table, and vice versa. The cell set does not support theadd
oraddAll
methods.
-
values
public ImmutableCollection<V> values()
Description copied from interface:Table
Returns a collection of all values, which may contain duplicates. Changes to the returned collection will update the underlying table, and vice versa.
-
column
public ImmutableMap<R,V> column(C columnKey)
Returns a view of all mappings that have the given column key. For each row key / column key / value mapping in the table with that column key, the returned map associates the row key with the value. If no mappings in the table have the provided column key, an empty map is returned.Changes to the returned map will update the underlying table, and vice versa.
-
columnKeySet
public ImmutableSet<C> columnKeySet()
Description copied from interface:Table
Returns a set of column keys that have one or more values in the table. Changes to the set will update the underlying table, and vice versa.- Specified by:
columnKeySet
in interfaceTable<R,C,V>
- Returns:
- set of column keys
-
columnMap
public abstract ImmutableMap<C,java.util.Map<R,V>> columnMap()
Returns a view that associates each column key with the corresponding map from row keys to values. Changes to the returned map will update this table. The returned map does not supportput()
orputAll()
, orsetValue()
on its entries.In contrast, the maps returned by
columnMap().get()
have the same behavior as those returned byTable.column(C)
. Those maps may supportsetValue()
,put()
, andputAll()
.The value
Map<R, V>
instances in the returned map areImmutableMap
instances as well.
-
row
public ImmutableMap<C,V> row(R rowKey)
Returns a view of all mappings that have the given row key. For each row key / column key / value mapping in the table with that row key, the returned map associates the column key with the value. If no mappings in the table have the provided row key, an empty map is returned.Changes to the returned map will update the underlying table, and vice versa.
-
rowKeySet
public ImmutableSet<R> rowKeySet()
Description copied from interface:Table
Returns a set of row keys that have one or more values in the table. Changes to the set will update the underlying table, and vice versa.
-
rowMap
public abstract ImmutableMap<R,java.util.Map<C,V>> rowMap()
Returns a view that associates each row key with the corresponding map from column keys to values. Changes to the returned map will update this table. The returned map does not supportput()
orputAll()
, orsetValue()
on its entries.In contrast, the maps returned by
rowMap().get()
have the same behavior as those returned byTable.row(R)
. Those maps may supportsetValue()
,put()
, andputAll()
.The value
Map<C, V>
instances in the returned map areImmutableMap
instances as well.
-
contains
public boolean contains(@CheckForNull java.lang.Object rowKey, @CheckForNull java.lang.Object columnKey)
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified row and column keys.
-
containsValue
public boolean containsValue(@CheckForNull java.lang.Object value)
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified value.- Specified by:
containsValue
in interfaceTable<R,C,V>
- Parameters:
value
- value to search for
-
clear
@Deprecated public final void clear()
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the table unmodified.
-
put
@CanIgnoreReturnValue @Deprecated @CheckForNull public final V put(R rowKey, C columnKey, V value)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the table unmodified.- Specified by:
put
in interfaceTable<R,C,V>
- Parameters:
rowKey
- row key that the value should be associated withcolumnKey
- column key that the value should be associated withvalue
- value to be associated with the specified keys- Returns:
- the value previously associated with the keys, or
null
if no mapping existed for the keys - Throws:
java.lang.UnsupportedOperationException
- always
-
putAll
@Deprecated public final void putAll(Table<? extends R,? extends C,? extends V> table)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the table unmodified.
-
remove
@CanIgnoreReturnValue @Deprecated @CheckForNull public final V remove(@CheckForNull java.lang.Object rowKey, @CheckForNull java.lang.Object columnKey)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the table unmodified.
-
containsRow
public boolean containsRow(@CheckForNull java.lang.Object rowKey)
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified row key.- Specified by:
containsRow
in interfaceTable<R extends @Nullable java.lang.Object,C extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Parameters:
rowKey
- key of row to search for
-
containsColumn
public boolean containsColumn(@CheckForNull java.lang.Object columnKey)
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified column.- Specified by:
containsColumn
in interfaceTable<R extends @Nullable java.lang.Object,C extends @Nullable java.lang.Object,V extends @Nullable java.lang.Object>
- Parameters:
columnKey
- key of column to search for
-
get
@CheckForNull public V get(@CheckForNull java.lang.Object rowKey, @CheckForNull java.lang.Object columnKey)
Description copied from interface:Table
Returns the value corresponding to the given row and column keys, ornull
if no such mapping exists.
-
isEmpty
public boolean isEmpty()
Description copied from interface:Table
Returnstrue
if the table contains no mappings.
-
equals
public boolean equals(@CheckForNull java.lang.Object obj)
Description copied from interface:Table
Compares the specified object with this table for equality. Two tables are equal when their cell views, as returned byTable.cellSet()
, are equal.
-
hashCode
public int hashCode()
Description copied from interface:Table
Returns the hash code for this table. The hash code of a table is defined as the hash code of its cell view, as returned byTable.cellSet()
.
-
toString
public java.lang.String toString()
Returns the string representationrowMap().toString()
.- Overrides:
toString
in classjava.lang.Object
-
-