Class ImmutableTable<R,C,V>
- java.lang.Object
-
- com.google.common.collect.AbstractTable<R,C,V>
-
- com.google.common.collect.ImmutableTable<R,C,V>
-
- All Implemented Interfaces:
Table<R,C,V>
,java.io.Serializable
- Direct Known Subclasses:
RegularImmutableTable
,SingletonImmutableTable
@GwtCompatible public abstract class ImmutableTable<R,C,V> extends AbstractTable<R,C,V> 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
- 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").private static class
ImmutableTable.CollectorState<R,C,V>
private static class
ImmutableTable.MutableCell<R,C,V>
(package private) static class
ImmutableTable.SerializedForm
Serialized type for all ImmutableTable instances.-
Nested classes/interfaces inherited from class com.google.common.collect.AbstractTable
AbstractTable.CellSet, AbstractTable.Values
-
Nested classes/interfaces inherited from interface com.google.common.collect.Table
Table.Cell<R,C,V>
-
-
Constructor Summary
Constructors Constructor Description ImmutableTable()
-
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.(package private) UnmodifiableIterator<Table.Cell<R,C,V>>
cellIterator()
(package private) static <R,C,V>
Table.Cell<R,C,V>cellOf(R rowKey, C columnKey, V value)
Verifies thatrowKey
,columnKey
andvalue
are non-null, and returns a new entry with those values.ImmutableSet<Table.Cell<R,C,V>>
cellSet()
Returns a set of all row key / column key / value triplets.(package private) java.util.Spliterator<Table.Cell<R,C,V>>
cellSpliterator()
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
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.private static <R,C,V>
ImmutableTable<R,C,V>copyOf(java.lang.Iterable<? extends Table.Cell<? extends R,? extends C,? extends V>> cells)
(package private) abstract ImmutableSet<Table.Cell<R,C,V>>
createCellSet()
(package private) abstract ImmutableTable.SerializedForm
createSerializedForm()
Creates the common serialized form for this table.(package private) abstract ImmutableCollection<V>
createValues()
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,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,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
.ImmutableCollection<V>
values()
Returns a collection of all values, which may contain duplicates.(package private) java.util.Iterator<V>
valuesIterator()
(package private) java.lang.Object
writeReplace()
-
Methods inherited from class com.google.common.collect.AbstractTable
containsColumn, containsRow, equals, get, hashCode, isEmpty, toString, valuesSpliterator
-
-
-
-
Method Detail
-
toImmutableTable
@Beta public static <T,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:
- 21.0
-
toImmutableTable
public static <T,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:
- 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 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.
-
copyOf
private static <R,C,V> ImmutableTable<R,C,V> copyOf(java.lang.Iterable<? extends Table.Cell<? extends R,? extends C,? extends V>> cells)
-
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.
-
cellOf
static <R,C,V> Table.Cell<R,C,V> cellOf(R rowKey, C columnKey, V value)
Verifies thatrowKey
,columnKey
andvalue
are non-null, and returns a new entry with those values.
-
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.
-
createCellSet
abstract ImmutableSet<Table.Cell<R,C,V>> createCellSet()
- Overrides:
createCellSet
in classAbstractTable<R,C,V>
-
cellIterator
final UnmodifiableIterator<Table.Cell<R,C,V>> cellIterator()
- Specified by:
cellIterator
in classAbstractTable<R,C,V>
-
cellSpliterator
final java.util.Spliterator<Table.Cell<R,C,V>> cellSpliterator()
- Specified by:
cellSpliterator
in classAbstractTable<R,C,V>
-
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.
-
createValues
abstract ImmutableCollection<V> createValues()
- Overrides:
createValues
in classAbstractTable<R,C,V>
-
valuesIterator
final java.util.Iterator<V> valuesIterator()
- Overrides:
valuesIterator
in classAbstractTable<R,C,V>
-
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>
- Overrides:
columnKeySet
in classAbstractTable<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(java.lang.Object rowKey, 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(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>
- Overrides:
containsValue
in classAbstractTable<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
@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 interfaceTable<R,C,V>
- Overrides:
put
in classAbstractTable<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
@Deprecated public final V remove(java.lang.Object rowKey, java.lang.Object columnKey)
Deprecated.Unsupported operation.Guaranteed to throw an exception and leave the table unmodified.- Specified by:
remove
in interfaceTable<R,C,V>
- Overrides:
remove
in classAbstractTable<R,C,V>
- Parameters:
rowKey
- row key of mapping to be removedcolumnKey
- column key of mapping to be removed- Returns:
- the value previously associated with the keys, or
null
if no such value existed - Throws:
java.lang.UnsupportedOperationException
- always
-
createSerializedForm
abstract ImmutableTable.SerializedForm createSerializedForm()
Creates the common serialized form for this table.
-
writeReplace
final java.lang.Object writeReplace()
-
-