Package com.google.common.collect
Class ForwardingTable<R,C,V>
java.lang.Object
com.google.common.collect.ForwardingObject
com.google.common.collect.ForwardingTable<R,C,V>
- All Implemented Interfaces:
Table<R,
C, V>
- Direct Known Subclasses:
Tables.UnmodifiableTable
A table which forwards all its method calls to another table. Subclasses should override one or
more methods to modify the behavior of the backing map as desired per the decorator pattern.
- Since:
- 7.0
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.google.common.collect.Table
Table.Cell<R,
C, V> -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSet
<Table.Cell<R, C, V>> cellSet()
Returns a set of all row key / column key / value triplets.void
clear()
Removes all mappings from the table.Returns a view of all mappings that have the given column key.Returns a set of column keys that have one or more values in the table.Returns a view that associates each column key with the corresponding map from row keys to values.boolean
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.delegate()
Returns the backing delegate instance that methods are forwarded to.boolean
Compares the specified object with this table for equality.Returns the value corresponding to the given row and column keys, ornull
if no such mapping exists.int
hashCode()
Returns the hash code for this table.boolean
isEmpty()
Returnstrue
if the table contains no mappings.Associates the specified value with the specified keys.void
Copies all mappings from the specified table to this table.Removes the mapping, if any, associated with the given keys.Returns a view of all mappings that have the given row key.Returns a set of row keys that have one or more values in the table.rowMap()
Returns a view that associates each row key with the corresponding map from column keys to values.int
size()
Returns the number of row key / column key / value mappings in the table.values()
Returns a collection of all values, which may contain duplicates.Methods inherited from class com.google.common.collect.ForwardingObject
toString
-
Constructor Details
-
ForwardingTable
protected ForwardingTable()Constructor for use by subclasses.
-
-
Method Details
-
delegate
Description copied from class:ForwardingObject
Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such asForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegate
in classForwardingObject
-
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. -
clear
public void clear()Description copied from interface:Table
Removes all mappings from the table. -
column
Description copied from interface:Table
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
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
Description copied from interface:Table
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()
. -
contains
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified row and column keys. -
containsColumn
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified column.- Specified by:
containsColumn
in interfaceTable<R,
C, V> - Parameters:
columnKey
- key of column to search for
-
containsRow
Description copied from interface:Table
Returnstrue
if the table contains a mapping with the specified row key.- Specified by:
containsRow
in interfaceTable<R,
C, V> - Parameters:
rowKey
- key of row to search for
-
containsValue
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
-
get
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. -
put
Description copied from interface:Table
Associates the specified value with the specified keys. If the table already contained a mapping for those keys, the old value is replaced with the specified value.- 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
-
putAll
Description copied from interface:Table
Copies all mappings from the specified table to this table. The effect is equivalent to callingTable.put(R, C, V)
with each row key / column key / value mapping intable
. -
remove
Description copied from interface:Table
Removes the mapping, if any, associated with the given keys. -
row
Description copied from interface:Table
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
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
Description copied from interface:Table
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()
. -
size
public int size()Description copied from interface:Table
Returns the number of row key / column key / value mappings in the table. -
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. -
equals
Description copied from interface:Table
Compares the specified object with this table for equality. Two tables are equal when their cell views, as returned byTable.cellSet()
, are equal. -
hashCode
public int hashCode()Description copied from interface:Table
Returns the hash code for this table. The hash code of a table is defined as the hash code of its cell view, as returned byTable.cellSet()
.
-