ImmutableTable (Guava: Google Core Libraries for Java 28.1-jre API)

java.lang.Object
- com.google.common.collect.ImmutableTable<R,C,V>

All Implemented Interfaces:

Table<R,C,V>, Serializable
```
@GwtCompatible
public abstract class ImmutableTable<R,C,V>
extends Object
implements Serializable
```
A Table whose contents will never change, with many other important properties detailed at ImmutableCollection.
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 and Description
`static class`	`ImmutableTable.Builder<R,C,V>` A builder for creating immutable table instances, especially `public static final` tables ("constant tables").

Nested classes/interfaces inherited from interface com.google.common.collect.Table
Table.Cell<R,C,V>

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and 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,Map<R,V>>`	`columnMap()` Returns a view that associates each column key with the corresponding map from row keys to values.
`boolean`	`contains(@Nullable Object rowKey, @Nullable Object columnKey)` Returns `true` if the table contains a mapping with the specified row and column keys.
`boolean`	`containsColumn(@Nullable Object columnKey)` Returns `true` if the table contains a mapping with the specified column.
`boolean`	`containsRow(@Nullable Object rowKey)` Returns `true` if the table contains a mapping with the specified row key.
`boolean`	`containsValue(@Nullable Object value)` Returns `true` 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(@Nullable Object obj)` Indicates whether some other object is "equal to" this one.
`V`	`get(@Nullable Object rowKey, @Nullable Object columnKey)` Returns the value corresponding to the given row and column keys, or `null` if no such mapping exists.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isEmpty()` Returns `true` 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(Object rowKey, 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,Map<C,V>>`	`rowMap()` Returns a view that associates each row key with the corresponding map from column keys to values.
`static <T,R,C,V> Collector<T,?,ImmutableTable<R,C,V>>`	`toImmutableTable(Function<? super T,? extends R> rowFunction, Function<? super T,? extends C> columnFunction, Function<? super T,? extends V> valueFunction)` Returns a `Collector` that accumulates elements into an `ImmutableTable`.
`static <T,R,C,V> Collector<T,?,ImmutableTable<R,C,V>>`	`toImmutableTable(Function<? super T,? extends R> rowFunction, Function<? super T,? extends C> columnFunction, Function<? super T,? extends V> valueFunction, BinaryOperator<V> mergeFunction)` Returns a `Collector` that accumulates elements into an `ImmutableTable`.
`String`	`toString()` Returns the string representation `rowMap().toString()`.
`ImmutableCollection<V>`	`values()` Returns a collection of all values, which may contain duplicates.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.common.collect.Table
size

- Method Detail
  - toImmutableTable
```
public static <T,R,C,V> Collector<T,?,ImmutableTable<R,C,V>> toImmutableTable(Function<? super T,? extends R> rowFunction,
                                                                              Function<? super T,? extends C> columnFunction,
                                                                              Function<? super T,? extends V> valueFunction)
```
    Returns a Collector that accumulates elements into an ImmutableTable. 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 a NullPointerException at collection time if the row, column, or value functions return null on any input.
    
    Since:
    
    21.0
  - toImmutableTable
```
public static <T,R,C,V> Collector<T,?,ImmutableTable<R,C,V>> toImmutableTable(Function<? super T,? extends R> rowFunction,
                                                                              Function<? super T,? extends C> columnFunction,
                                                                              Function<? super T,? extends V> valueFunction,
                                                                              BinaryOperator<V> mergeFunction)
```
    Returns a Collector that accumulates elements into an ImmutableTable. 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 a NullPointerException at collection time if the row, column, value, or merging functions return null on any input.
    
    Since:
    
    21.0
  - of
```
public static <R,C,V> ImmutableTable<R,C,V> of()
```
    Returns an empty immutable table.
  - 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 a ImmutableTable.Builder and call ImmutableTable.Builder.orderRowsBy(java.util.Comparator<? super R>), ImmutableTable.Builder.orderColumnsBy(java.util.Comparator<? super C>), and ImmutableTable.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 the ImmutableTable.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 the add or addAll methods.
    
    Specified by:
    
    cellSet in interface Table<R,C,V>
    
    Returns:
    
    set of table cells consisting of row key / column key / value triplets
  - 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.
    
    Specified by:
    
    values in interface Table<R,C,V>
    
    Returns:
    
    collection of values
  - 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.
    
    Specified by:
    
    column in interface Table<R,C,V>
    
    Parameters:
    
    columnKey - key of column to search for in the table
    
    Returns:
    
    the corresponding map from row keys to values
    
    Throws:
    
    NullPointerException - if columnKey is null
  - 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 interface Table<R,C,V>
    
    Returns:
    
    set of column keys
  - columnMap
```
public abstract ImmutableMap<C,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 support put() or putAll(), or setValue() on its entries.
    In contrast, the maps returned by columnMap().get() have the same behavior as those returned by Table.column(C). Those maps may support setValue(), put(), and putAll().
    The value Map<R, V> instances in the returned map are ImmutableMap instances as well.
    
    Specified by:
    
    columnMap in interface Table<R,C,V>
    
    Returns:
    
    a map view from each column key to a secondary map from row keys to values
  - 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.
    
    Specified by:
    
    row in interface Table<R,C,V>
    
    Parameters:
    
    rowKey - key of row to search for in the table
    
    Returns:
    
    the corresponding map from column keys to values
    
    Throws:
    
    NullPointerException - if rowKey is null
  - 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.
    
    Specified by:
    
    rowKeySet in interface Table<R,C,V>
    
    Returns:
    
    set of row keys
  - rowMap
```
public abstract ImmutableMap<R,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 support put() or putAll(), or setValue() on its entries.
    In contrast, the maps returned by rowMap().get() have the same behavior as those returned by Table.row(R). Those maps may support setValue(), put(), and putAll().
    The value Map<C, V> instances in the returned map are ImmutableMap instances as well.
    
    Specified by:
    
    rowMap in interface Table<R,C,V>
    
    Returns:
    
    a map view from each row key to a secondary map from column keys to values
  - contains
```
public boolean contains(@Nullable Object rowKey,
                        @Nullable Object columnKey)
```
    Description copied from interface: Table
    
    Returns true if the table contains a mapping with the specified row and column keys.
    
    Specified by:
    
    contains in interface Table<R,C,V>
    
    Parameters:
    
    rowKey - key of row to search for
    
    columnKey - key of column to search for
  - containsValue
```
public boolean containsValue(@Nullable Object value)
```
    Description copied from interface: Table
    
    Returns true if the table contains a mapping with the specified value.
    
    Specified by:
    
    containsValue in interface Table<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.
    
    Specified by:
    
    clear in interface Table<R,C,V>
    
    Throws:
    
    UnsupportedOperationException - always
  - put
```
@CanIgnoreReturnValue
 @Deprecated
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 interface Table<R,C,V>
    
    Parameters:
    
    rowKey - row key that the value should be associated with
    
    columnKey - column key that the value should be associated with
    
    value - 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:
    
    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.
    
    Specified by:
    
    putAll in interface Table<R,C,V>
    
    Parameters:
    
    table - the table to add to this table
    
    Throws:
    
    UnsupportedOperationException - always
  - remove
```
@CanIgnoreReturnValue
 @Deprecated
public final V remove(Object rowKey,
                                                         Object columnKey)
```
    Deprecated. Unsupported operation.
    
    Guaranteed to throw an exception and leave the table unmodified.
    
    Specified by:
    
    remove in interface Table<R,C,V>
    
    Parameters:
    
    rowKey - row key of mapping to be removed
    
    columnKey - column key of mapping to be removed
    
    Returns:
    
    the value previously associated with the keys, or null if no such value existed
    
    Throws:
    
    UnsupportedOperationException - always
  - containsRow
```
public boolean containsRow(@Nullable Object rowKey)
```
    Description copied from interface: Table
    
    Returns true if the table contains a mapping with the specified row key.
    
    Specified by:
    
    containsRow in interface Table<R,C,V>
    
    Parameters:
    
    rowKey - key of row to search for
  - containsColumn
```
public boolean containsColumn(@Nullable Object columnKey)
```
    Description copied from interface: Table
    
    Returns true if the table contains a mapping with the specified column.
    
    Specified by:
    
    containsColumn in interface Table<R,C,V>
    
    Parameters:
    
    columnKey - key of column to search for
  - get
```
public V get(@Nullable Object rowKey,
             @Nullable Object columnKey)
```
    Description copied from interface: Table
    
    Returns the value corresponding to the given row and column keys, or null if no such mapping exists.
    
    Specified by:
    
    get in interface Table<R,C,V>
    
    Parameters:
    
    rowKey - key of row to search for
    
    columnKey - key of column to search for
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Table
    
    Returns true if the table contains no mappings.
    
    Specified by:
    
    isEmpty in interface Table<R,C,V>
  - equals
```
public boolean equals(@Nullable Object obj)
```
    Description copied from class: java.lang.Object
    Indicates whether some other object is "equal to" this one.
    The equals method implements an equivalence relation on non-null object references:
    - It is reflexive: for any non-null reference value x, x.equals(x) should return true.
    - It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
    - For any non-null reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).
    Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.
    Specified by:
    
    equals in interface Table<R,C,V>
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    Object.hashCode(), HashMap
  - hashCode
```
public int hashCode()
```
    Description copied from class: java.lang.Object
    Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.
    The general contract of hashCode is:
    - Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
    - If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
    - It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
    As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)
    Specified by:
    
    hashCode in interface Table<R,C,V>
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)
  - toString
```
public String toString()
```
    Returns the string representation rowMap().toString().
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class ImmutableTable<R,C,V>

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.collect.Table

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.common.collect.Table

Method Detail

toImmutableTable

toImmutableTable

of

of

copyOf

builder

cellSet

values

column

columnKeySet

columnMap

row

rowKeySet

rowMap

contains

containsValue

clear

put

putAll

remove

containsRow

containsColumn

get

isEmpty

equals

hashCode

toString