@GwtCompatible public abstract class ForwardingTable<R,C,V> extends ForwardingObject implements Table<R,C,V>
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.
Table.Cell<R,C,V>| Modifier | Constructor and Description |
|---|---|
protected |
ForwardingTable()
Constructor for use by subclasses.
|
| Modifier and Type | Method and Description |
|---|---|
Set<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.
|
Map<R,V> |
column(C columnKey)
Returns a view of all mappings that have the given column key.
|
Set<C> |
columnKeySet()
Returns a set of column keys that have one or more values in the table.
|
Map<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. |
protected abstract Table<R,C,V> |
delegate()
Returns the backing delegate instance that methods are forwarded to.
|
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. |
V |
put(R rowKey,
C columnKey,
V value)
Associates the specified value with the specified keys.
|
void |
putAll(Table<? extends R,? extends C,? extends V> table)
Copies all mappings from the specified table to this table.
|
V |
remove(Object rowKey,
Object columnKey)
Removes the mapping, if any, associated with the given keys.
|
Map<C,V> |
row(R rowKey)
Returns a view of all mappings that have the given row key.
|
Set<R> |
rowKeySet()
Returns a set of row keys that have one or more values in the table.
|
Map<R,Map<C,V>> |
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.
|
Collection<V> |
values()
Returns a collection of all values, which may contain duplicates.
|
toStringprotected abstract Table<R,C,V> delegate()
ForwardingObjectReturns 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 as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.
delegate in class ForwardingObjectpublic Set<Table.Cell<R,C,V>> cellSet()
TableReturns 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 the add or addAll methods.
public void clear()
TableRemoves all mappings from the table.
public Map<R,V> column(C columnKey)
TableReturns 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.
public Set<C> columnKeySet()
TableReturns 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.
columnKeySet in interface Table<R,C,V>public Map<C,Map<R,V>> columnMap()
TableReturns 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 support 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().
public boolean contains(Object rowKey, Object columnKey)
TableReturns true if the table contains a mapping with the specified row and column keys.
public boolean containsColumn(Object columnKey)
TableReturns 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 boolean containsRow(Object rowKey)
TableReturns 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 containsValue(Object value)
TableReturns true if the table contains a mapping with the specified value.
containsValue in interface Table<R,C,V>value - value to search forpublic V get(Object rowKey, Object columnKey)
TableReturns the value corresponding to the given row and column keys, or null if no such mapping exists.
public boolean isEmpty()
TableReturns true if the table contains no mappings.
public V put(R rowKey, C columnKey, V value)
TableAssociates 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.
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 keyspublic void putAll(Table<? extends R,? extends C,? extends V> table)
TableCopies all mappings from the specified table to this table. The effect is equivalent to calling Table.put(R, C, V) with each row key / column key / value mapping in table.
public V remove(Object rowKey, Object columnKey)
TableRemoves the mapping, if any, associated with the given keys.
public Map<C,V> row(R rowKey)
TableReturns 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.
public Set<R> rowKeySet()
TableReturns 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.
public Map<R,Map<C,V>> rowMap()
TableReturns 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 support 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().
public int size()
TableReturns the number of row key / column key / value mappings in the table.
public Collection<V> values()
TableReturns a collection of all values, which may contain duplicates. Changes to the returned collection will update the underlying table, and vice versa.
public boolean equals(Object obj)
TableCompares the specified object with this table for equality. Two tables are equal when their cell views, as returned by Table.cellSet(), are equal.