public abstract class ImmutableTable<R,C,V> extends AbstractTable<R,C,V> implements java.io.Serializable
Table
whose contents will never change, with many other important properties detailed
at ImmutableCollection
.
See the Guava User Guide article on immutable collections.
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"). |
(package private) static class |
ImmutableTable.SerializedForm
Serialized type for all ImmutableTable instances.
|
AbstractTable.CellSet, AbstractTable.Values
Table.Cell<R,C,V>
Constructor and Description |
---|
ImmutableTable() |
Modifier and Type | Method and 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 that
rowKey , columnKey and value 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)
Returns
true if the table contains a mapping with the specified row and column keys. |
boolean |
containsValue(java.lang.Object value)
Returns
true if the table contains a mapping with the specified value. |
(package private) static <R,C,V> ImmutableTable<R,C,V> |
copyOf(java.lang.Iterable<? extends Table.Cell<? extends R,? extends C,? extends V>> cells) |
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.
|
(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 a
Collector that accumulates elements into an ImmutableTable . |
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 a
Collector that accumulates elements into an ImmutableTable . |
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() |
containsColumn, containsRow, equals, get, hashCode, isEmpty, toString, valuesSpliterator
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)
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.
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)
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.
public static <R,C,V> ImmutableTable<R,C,V> of()
Performance note: the instance returned is a singleton.
public static <R,C,V> ImmutableTable<R,C,V> of(R rowKey, C columnKey, V value)
public static <R,C,V> ImmutableTable<R,C,V> copyOf(Table<? extends R,? extends C,? extends V> 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.
static <R,C,V> ImmutableTable<R,C,V> copyOf(java.lang.Iterable<? extends Table.Cell<? extends R,? extends C,? extends V>> cells)
public static <R,C,V> ImmutableTable.Builder<R,C,V> builder()
ImmutableTable.Builder()
constructor.static <R,C,V> Table.Cell<R,C,V> cellOf(R rowKey, C columnKey, V value)
rowKey
, columnKey
and value
are non-null, and returns a
new entry with those values.public ImmutableSet<Table.Cell<R,C,V>> cellSet()
Table
add
or
addAll
methods.abstract ImmutableSet<Table.Cell<R,C,V>> createCellSet()
createCellSet
in class AbstractTable<R,C,V>
final UnmodifiableIterator<Table.Cell<R,C,V>> cellIterator()
cellIterator
in class AbstractTable<R,C,V>
final java.util.Spliterator<Table.Cell<R,C,V>> cellSpliterator()
cellSpliterator
in class AbstractTable<R,C,V>
public ImmutableCollection<V> values()
Table
abstract ImmutableCollection<V> createValues()
createValues
in class AbstractTable<R,C,V>
final java.util.Iterator<V> valuesIterator()
valuesIterator
in class AbstractTable<R,C,V>
public ImmutableMap<R,V> column(C columnKey)
Changes to the returned map will update the underlying table, and vice versa.
public ImmutableSet<C> columnKeySet()
Table
columnKeySet
in interface Table<R,C,V>
columnKeySet
in class AbstractTable<R,C,V>
public abstract ImmutableMap<C,java.util.Map<R,V>> columnMap()
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.
public ImmutableMap<C,V> row(R rowKey)
Changes to the returned map will update the underlying table, and vice versa.
public ImmutableSet<R> rowKeySet()
Table
public abstract ImmutableMap<R,java.util.Map<C,V>> rowMap()
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.
public boolean contains(@CheckForNull java.lang.Object rowKey, @CheckForNull java.lang.Object columnKey)
Table
true
if the table contains a mapping with the specified row and column keys.public boolean containsValue(@CheckForNull java.lang.Object value)
Table
true
if the table contains a mapping with the specified value.containsValue
in interface Table<R,C,V>
containsValue
in class AbstractTable<R,C,V>
value
- value to search for@Deprecated public final void clear()
@Deprecated @CheckForNull public final V put(R rowKey, C columnKey, V value)
put
in interface Table<R,C,V>
put
in class AbstractTable<R,C,V>
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 keysnull
if no mapping existed
for the keysjava.lang.UnsupportedOperationException
- always@Deprecated public final void putAll(Table<? extends R,? extends C,? extends V> table)
@Deprecated @CheckForNull public final V remove(@CheckForNull java.lang.Object rowKey, @CheckForNull java.lang.Object columnKey)
remove
in interface Table<R,C,V>
remove
in class AbstractTable<R,C,V>
rowKey
- row key of mapping to be removedcolumnKey
- column key of mapping to be removednull
if no such value existedjava.lang.UnsupportedOperationException
- alwaysabstract ImmutableTable.SerializedForm createSerializedForm()
final java.lang.Object writeReplace()