@GwtCompatible public abstract class ImmutableTable<R,C,V> extends Object implements 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"). |
Table.Cell<R,C,V>
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(Object rowKey,
Object columnKey)
Returns
true if the table contains a mapping with the specified row and column keys. |
boolean |
containsColumn(Object columnKey)
Returns
true if the table contains a mapping with the specified column. |
boolean |
containsRow(Object rowKey)
Returns
true if the table contains a mapping with the specified row key. |
boolean |
containsValue(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(Object obj)
Compares the specified object with this table for equality.
|
V |
get(Object rowKey,
Object columnKey)
Returns the value corresponding to the given row and column keys, or
null if no such
mapping exists. |
int |
hashCode()
Returns the hash code for this table.
|
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.
|
@Beta 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)
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> 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)
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()
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.
public static <R,C,V> ImmutableTable.Builder<R,C,V> builder()
ImmutableTable.Builder()
constructor.public ImmutableSet<Table.Cell<R,C,V>> cellSet()
Table
add
or
addAll
methods.public ImmutableCollection<V> values()
Table
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>
public abstract ImmutableMap<C,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,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(Object rowKey, Object columnKey)
Table
true
if the table contains a mapping with the specified row and column keys.public boolean containsValue(Object value)
Table
true
if the table contains a mapping with the specified value.containsValue
in interface Table<R,C,V>
value
- value to search for@Deprecated public final void clear()
@Deprecated public final V put(R rowKey, C columnKey, V value)
put
in interface Table<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 keysUnsupportedOperationException
- always@Deprecated public final void putAll(Table<? extends R,? extends C,? extends V> table)
@Deprecated public final V remove(Object rowKey, Object columnKey)
public boolean containsRow(Object rowKey)
Table
true
if the table contains a mapping with the specified row key.containsRow
in interface Table<R,C,V>
rowKey
- key of row to search forpublic boolean containsColumn(Object columnKey)
Table
true
if the table contains a mapping with the specified column.containsColumn
in interface Table<R,C,V>
columnKey
- key of column to search forpublic V get(Object rowKey, Object columnKey)
Table
null
if no such
mapping exists.public boolean isEmpty()
Table
true
if the table contains no mappings.public boolean equals(Object obj)
Table
Table.cellSet()
, are equal.public int hashCode()
Table
Table.cellSet()
.Copyright © 2010–2019. All rights reserved.