Top Description Inners Methods
com.google.common.collect

public Interface Table<R extends @Nullable Object, C extends @Nullable Object, V extends @Nullable Object>

Known Direct Subinterfaces
com.google.common.collect.RowSortedTable
Known Direct Implementers
com.google.common.collect.AbstractTable, com.google.common.collect.ForwardingTable, com.google.common.collect.Synchronized.SynchronizedTable
Annotations
@DoNotMock:Use ImmutableTable, HashBasedTable, or another implementation
@GwtCompatible
@ElementTypesAreNonnullByDefault
Type Parameters
<R>
the type of the table row keys
<C>
the type of the table column keys
<V>
the type of the mapped values
Imports
com.google.common.annotations.GwtCompatible, com.google.common.base.Objects, com.google.errorprone.annotations.CanIgnoreReturnValue, .CompatibleWith, .DoNotMock, java.util.Collection, .Map, .Set, javax.annotation.CheckForNull, org.checkerframework.checker.nullness.qual.Nullable
A collection that associates an ordered pair of keys, called a row key and a column key, with a single value. A table may be sparse, with only a small fraction of row key / column key pairs possessing a corresponding value.

The mappings corresponding to a given row key may be viewed as a Map whose keys are the columns. The reverse is also available, associating a column with a row key / value map. Note that, in some implementations, data access by column key may have fewer supported operations or worse performance than data access by row key.

The methods returning collections or maps always return views of the underlying table. Updating the table can change the contents of those collections, and updating the collections will change the table.

All methods that modify the table are optional, and the views returned by the table may or may not be modifiable. When modification isn't supported, those methods will throw an UnsupportedOperationException.

Implementations

See the Guava User Guide article on Table.

Author
Jared Levy
Since
7.0

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
Table.Cell<R extends @Nullable Object, C extends @Nullable Object, V extends @Nullable Object>

Row key / column key / value triplet corresponding to a mapping in a table.

Method Summary

Modifier and TypeMethod and Description
public Set<Table.Cell<R, C, V>>

Returns:

set of table cells consisting of row key / column key / value triplets
cellSet()

Returns a set of all row key / column key / value triplets.

public void
clear()

Removes all mappings from the table.

public Map<R, V>

Returns:

the corresponding map from row keys to values
column(C
key of column to search for in the table
columnKey)

Returns a view of all mappings that have the given column key.

public Set<C>

Returns:

set of column keys
columnKeySet()

Returns a set of column keys that have one or more values in the table.

public Map<C, Map<R, V>>

Returns:

a map view from each column key to a secondary map from row keys to values
columnMap()

Returns a view that associates each column key with the corresponding map from row keys to values.

public boolean
contains(Object
key of row to search for
rowKey, Object
key of column to search for
columnKey)

Returns true if the table contains a mapping with the specified row and column keys.

public boolean
containsColumn(Object
key of column to search for
columnKey)

Returns true if the table contains a mapping with the specified column.

public boolean
containsRow(Object
key of row to search for
rowKey)

Returns true if the table contains a mapping with the specified row key.

public boolean
containsValue(Object
value to search for
value)

Returns true if the table contains a mapping with the specified value.

public boolean
equals(Object obj)

Compares the specified object with this table for equality.

public V
get(Object
key of row to search for
rowKey, Object
key of column to search for
columnKey)

Returns the value corresponding to the given row and column keys, or null if no such mapping exists.

public int
hashCode()

Returns the hash code for this table.

public boolean
isEmpty()

Returns true if the table contains no mappings.

public V

Returns:

the value previously associated with the keys, or null if no mapping existed for the keys
put(R
row key that the value should be associated with
rowKey, C
column key that the value should be associated with
columnKey, V
value to be associated with the specified keys
value)

Associates the specified value with the specified keys.

public void
putAll(Table<? extends R, ? extends C, ? extends V>
the table to add to this table
table)

Copies all mappings from the specified table to this table.

public V

Returns:

the value previously associated with the keys, or null if no such value existed
remove(Object
row key of mapping to be removed
rowKey, Object
column key of mapping to be removed
columnKey)

Removes the mapping, if any, associated with the given keys.

public Map<C, V>

Returns:

the corresponding map from column keys to values
row(R
key of row to search for in the table
rowKey)

Returns a view of all mappings that have the given row key.

public Set<R>

Returns:

set of row keys
rowKeySet()

Returns a set of row keys that have one or more values in the table.

public Map<R, Map<C, V>>

Returns:

a map view from each row key to a secondary map from column keys to values
rowMap()

Returns a view that associates each row key with the corresponding map from column keys to values.

public int
size()

Returns the number of row key / column key / value mappings in the table.

public Collection<V>

Returns:

collection of values
values()

Returns a collection of all values, which may contain duplicates.

Method Detail

cellSetback to summary
public Set<Table.Cell<R, C, V>> cellSet()

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 the add or addAll methods.

Returns:Set<Table.Cell<R, C, V>>

set of table cells consisting of row key / column key / value triplets

clearback to summary
public void clear()

Removes all mappings from the table.

columnback to summary
public Map<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.

Parameters
columnKey:C

key of column to search for in the table

Returns:Map<R, V>

the corresponding map from row keys to values

columnKeySetback to summary
public Set<C> columnKeySet()

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.

Returns:Set<C>

set of column keys

columnMapback to summary
public Map<C, 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 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 column. Those maps may support setValue(), put(), and putAll().

Returns:Map<C, Map<R, V>>

a map view from each column key to a secondary map from row keys to values

containsback to summary
public boolean contains(Object rowKey, Object columnKey)

Returns true if the table contains a mapping with the specified row and column keys.

Parameters
rowKey:Object

key of row to search for

columnKey:Object

key of column to search for

containsColumnback to summary
public boolean containsColumn(Object columnKey)

Returns true if the table contains a mapping with the specified column.

Parameters
columnKey:Object

key of column to search for

containsRowback to summary
public boolean containsRow(Object rowKey)

Returns true if the table contains a mapping with the specified row key.

Parameters
rowKey:Object

key of row to search for

containsValueback to summary
public boolean containsValue(Object value)

Returns true if the table contains a mapping with the specified value.

Parameters
value:Object

value to search for

equalsback to summary
public boolean equals(Object obj)

Compares the specified object with this table for equality. Two tables are equal when their cell views, as returned by cellSet, are equal.

Annotations
@Override
getback to summary
public V get(Object rowKey, Object columnKey)

Returns the value corresponding to the given row and column keys, or null if no such mapping exists.

Parameters
rowKey:Object

key of row to search for

columnKey:Object

key of column to search for

Annotations
@CheckForNull
hashCodeback to summary
public int hashCode()

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 by cellSet.

Annotations
@Override
isEmptyback to summary
public boolean isEmpty()

Returns true if the table contains no mappings.

putback to summary
public V put(R rowKey, C columnKey, V value)

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.

Parameters
rowKey:R

row key that the value should be associated with

columnKey:C

column key that the value should be associated with

value:V

value to be associated with the specified keys

Returns:V

the value previously associated with the keys, or null if no mapping existed for the keys

Annotations
@CanIgnoreReturnValue
@CheckForNull
putAllback to summary
public void putAll(Table<? extends R, ? extends C, ? extends V> table)

Copies all mappings from the specified table to this table. The effect is equivalent to calling put with each row key / column key / value mapping in table.

Parameters
table:Table<? extends R, ? extends C, ? extends V>

the table to add to this table

removeback to summary
public V remove(Object rowKey, Object columnKey)

Removes the mapping, if any, associated with the given keys.

Parameters
rowKey:Object

row key of mapping to be removed

columnKey:Object

column key of mapping to be removed

Returns:V

the value previously associated with the keys, or null if no such value existed

Annotations
@CanIgnoreReturnValue
@CheckForNull
rowback to summary
public Map<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.

Parameters
rowKey:R

key of row to search for in the table

Returns:Map<C, V>

the corresponding map from column keys to values

rowKeySetback to summary
public Set<R> rowKeySet()

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.

Returns:Set<R>

set of row keys

rowMapback to summary
public Map<R, 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 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 row. Those maps may support setValue(), put(), and putAll().

Returns:Map<R, Map<C, V>>

a map view from each row key to a secondary map from column keys to values

sizeback to summary
public int size()

Returns the number of row key / column key / value mappings in the table.

valuesback to summary
public Collection<V> values()

Returns a collection of all values, which may contain duplicates. Changes to the returned collection will update the underlying table, and vice versa.

Returns:Collection<V>

collection of values

com.google.common.collect back to summary

public Interface Table.Cell<R extends @Nullable Object, C extends @Nullable Object, V extends @Nullable Object>

Known Direct Implementers
com.google.common.collect.Tables.AbstractCell
Row key / column key / value triplet corresponding to a mapping in a table.
Since
7.0

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object obj)

Compares the specified object with this cell for equality.

public C
getColumnKey()

Returns the column key of this cell.

public R
getRowKey()

Returns the row key of this cell.

public V
getValue()

Returns the value of this cell.

public int
hashCode()

Returns the hash code of this cell.

Method Detail

equalsback to summary
public boolean equals(Object obj)

Compares the specified object with this cell for equality. Two cells are equal when they have equal row keys, column keys, and values.

Annotations
@Override
getColumnKeyback to summary
public C getColumnKey()

Returns the column key of this cell.

Annotations
@ParametricNullness
getRowKeyback to summary
public R getRowKey()

Returns the row key of this cell.

Annotations
@ParametricNullness
getValueback to summary
public V getValue()

Returns the value of this cell.

Annotations
@ParametricNullness
hashCodeback to summary
public int hashCode()

Returns the hash code of this cell.

The hash code of a table cell is equal to Objects#hashCode(e.getRowKey(), e.getColumnKey(), e.getValue()).

Annotations
@Override