Class ImmutableTable<R,C,V>
- 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
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,Map<R,V>>
columnMap()
Returns a view that associates each column key with the corresponding map from row keys to values.boolean
contains(Object rowKey, Object columnKey)
Returnstrue
if the table contains a mapping with the specified row and column keys.boolean
containsColumn(Object columnKey)
Returnstrue
if the table contains a mapping with the specified column.boolean
containsRow(Object rowKey)
Returnstrue
if the table contains a mapping with the specified row key.boolean
containsValue(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(Object obj)
Indicates whether some other object is "equal to" this one.V
get(Object rowKey, Object columnKey)
Returns the value corresponding to the given row and column keys, ornull
if no such mapping exists.int
hashCode()
Returns a hash code value for the object.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(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.String
toString()
Returns the string representationrowMap().toString()
.ImmutableCollection<V>
values()
Returns a collection of all values, which may contain duplicates.
-
-
-
Method Detail
-
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,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,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 Object rowKey, @CheckForNull 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 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:
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 Object rowKey, @CheckForNull Object columnKey)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the table unmodified.
-
containsRow
public boolean containsRow(@CheckForNull Object rowKey)
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified row key.
-
containsColumn
public boolean containsColumn(@CheckForNull Object columnKey)
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified column.
-
get
@CheckForNull public V get(@CheckForNull Object rowKey, @CheckForNull 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 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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.- Specified by:
equals
in interfaceTable<R extends @Nullable Object,C extends @Nullable Object,V extends @Nullable Object>
- Overrides:
equals
in classObject
- 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
- It is reflexive: for any non-null reference value
-
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 byHashMap
.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 inequals
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 thehashCode
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 thehashCode
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. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.) - Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
-