Top Description Inners Fields Constructors Methods

com.google.common.collect

public Class HashBasedTable<R, C, V>

Class Inheritance

extends StandardTable<R, C, V>

java.lang.Object
com.google.common.collect.AbstractTable
com.google.common.collect.StandardTable
com.google.common.collect.HashBasedTable

Annotations

@GwtCompatible
serializable:true
@ElementTypesAreNonnullByDefault

Static Imports

com.google.common.collect.CollectPreconditions.checkNonnegative

Implementation of Table using linked hash tables. This guarantees predictable iteration order of the various views.

The views returned by column, columnKeySet(), and columnMap() have iterators that don't support remove(). Otherwise, all optional operations are supported. Null row keys, columns keys, and values are not supported.

Lookups by row key are often faster than lookups by column key, because the data is stored in a Map<R, Map<C, V>>. A method call like column(columnKey).get(rowKey) still runs quickly, since the row key is provided. However, column(columnKey).size() takes longer, since an iteration across all row keys occurs.

Note that this implementation is not synchronized. If multiple threads access this table concurrently and one of the threads modifies the table, it must be synchronized externally.

See the Guava User Guide article on Table.

Author: Jared Levy
Since: 7.0

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	HashBasedTable.Factory<C, V>

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID Hides com.google.common.collect.StandardTable.serialVersionUID.

Inherited from com.google.common.collect.StandardTable:: backingMap factory

Constructor Summary

Access	Constructor and Description
pack-priv	HashBasedTable(Map<R, Map<C, V>> backingMap, HashBasedTable.Factory<C, V> factory)

Method Summary

Modifier and Type	Method and Description
public static <R, C, V> HashBasedTable<R, C, V>	create() Creates an empty `HashBasedTable`.
public static <R, C, V> HashBasedTable<R, C, V>	create(int the expected number of distinct row keys expectedRows, int the expected number of column key / value mappings in each row expectedCellsPerRow) Creates an empty `HashBasedTable` with the specified map sizes.
public static <R, C, V> HashBasedTable<R, C, V>	create(Table<? extends R, ? extends C, ? extends V> the table to copy table) Creates a `HashBasedTable` with the same mappings as the specified table.

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID Hides com.google.common.collect.StandardTable.serialVersionUID.

Constructor Detail

HashBasedTable	back to summary
pack-priv HashBasedTable(Map<R, Map<C, V>> backingMap, HashBasedTable.Factory<C, V> factory)

Method Detail

create	back to summary
public static <R, C, V> HashBasedTable<R, C, V> create() Creates an empty `HashBasedTable`.

create back to summary

create	back to summary
public static <R, C, V> HashBasedTable<R, C, V> create(int expectedRows, int expectedCellsPerRow) Creates an empty `HashBasedTable` with the specified map sizes. Parameters expectedRows:int the expected number of distinct row keys expectedCellsPerRow:int the expected number of column key / value mappings in each row Exceptions IllegalArgumentException: if `expectedRows` or `expectedCellsPerRow` is negative

public static <R, C, V> HashBasedTable<R, C, V> create(int expectedRows, int expectedCellsPerRow)

Creates an empty HashBasedTable with the specified map sizes.

Parameters

expectedRows:int: the expected number of distinct row keys
expectedCellsPerRow:int: the expected number of column key / value mappings in each row

Exceptions

IllegalArgumentException:: if expectedRows or expectedCellsPerRow is negative

create back to summary

create	back to summary
public static <R, C, V> HashBasedTable<R, C, V> create(Table<? extends R, ? extends C, ? extends V> table) Creates a `HashBasedTable` with the same mappings as the specified table. Parameters table:Table<? extends R, ? extends C, ? extends V> the table to copy Exceptions NullPointerException: if any of the row keys, column keys, or values in `table` is null

public static <R, C, V> HashBasedTable<R, C, V> create(Table<? extends R, ? extends C, ? extends V> table)

Creates a HashBasedTable with the same mappings as the specified table.

Parameters

table:Table<? extends R, ? extends C, ? extends V>: the table to copy

Exceptions

NullPointerException:: if any of the row keys, column keys, or values in table is null

com.google.common.collect back to summary

private Class HashBasedTable.Factory<C, V>

Class Inheritance

extends Object
implements Supplier<Map<C, V>>, Serializable

java.lang.Object
com.google.common.collect.HashBasedTable.Factory

All Implemented Interfaces

java.io.Serializable, com.google.common.base.Supplier, java.util.function.Supplier

Field Summary

Modifier and Type	Field and Description
pack-priv final int	expectedSize
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
pack-priv	Factory(int expectedSize)

Method Summary

Modifier and Type	Method and Description
public Map<C, V>	get() Implements com.google.common.base.Supplier.get. Retrieves an instance of the appropriate type.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

expectedSize	back to summary
pack-priv final int expectedSize

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

Factory	back to summary
pack-priv Factory(int expectedSize)

Method Detail

get	back to summary
public Map<C, V> get() Implements com.google.common.base.Supplier.get. Doc from com.google.common.base.Supplier.get. Retrieves an instance of the appropriate type. The returned object may or may not be a new instance, depending on the implementation. Returns:Map<C, V> an instance of the appropriate type Annotations @Override

get

back to summary

public Map<C, V> get()

Implements com.google.common.base.Supplier.get.

Doc from com.google.common.base.Supplier.get.

Retrieves an instance of the appropriate type. The returned object may or may not be a new instance, depending on the implementation.

Returns:Map<C, V>

an instance of the appropriate type

Annotations

@Override