|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.google.common.collect.ImmutableTable<R,C,V>
@Beta @GwtCompatible public abstract class ImmutableTable<R,C,V>
An immutable Table with reliable user-specified iteration order.
Does not permit null keys or values.
Note: Although this class is not final, it cannot be subclassed as it has no public or protected constructors. Thus, instances of this class are guaranteed to be immutable.
| Nested Class Summary | |
|---|---|
static class |
ImmutableTable.Builder<R,C,V>
A builder for creating immutable table instances, especially public
static final tables ("constant tables"). |
| Nested classes/interfaces inherited from interface com.google.common.collect.Table |
|---|
Table.Cell<R,C,V> |
| Method Summary | ||
|---|---|---|
static
|
builder()
Returns a new builder. |
|
abstract ImmutableSet<Table.Cell<R,C,V>> |
cellSet()
Returns a set of all row key / column key / value triplets. |
|
void |
clear()
Guaranteed to throw an exception and leave the table unmodified. |
|
abstract ImmutableMap<R,V> |
column(C columnKey)
Returns a view of all mappings that have the given column key. |
|
abstract 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. |
|
static
|
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. |
|
int |
hashCode()
Returns the hash code for this table. |
|
static
|
of()
Returns an empty immutable table. |
|
static
|
of(R rowKey,
C columnKey,
V value)
Returns an immutable table containing a single cell. |
|
V |
put(R rowKey,
C columnKey,
V value)
Guaranteed to throw an exception and leave the table unmodified. |
|
void |
putAll(Table<? extends R,? extends C,? extends V> table)
Guaranteed to throw an exception and leave the table unmodified. |
|
V |
remove(Object rowKey,
Object columnKey)
Guaranteed to throw an exception and leave the table unmodified. |
|
abstract ImmutableMap<C,V> |
row(R rowKey)
Returns a view of all mappings that have the given row key. |
|
abstract 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. |
|
String |
toString()
|
|
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface com.google.common.collect.Table |
|---|
contains, containsColumn, containsRow, containsValue, get, isEmpty, size, values |
| Method Detail |
|---|
public static final <R,C,V> ImmutableTable<R,C,V> of()
public static final <R,C,V> ImmutableTable<R,C,V> of(R rowKey,
C columnKey,
V value)
public static final <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 final <R,C,V> ImmutableTable.Builder<R,C,V> builder()
Builder#Builder() constructor.
public abstract ImmutableSet<Table.Cell<R,C,V>> cellSet()
Tableadd or addAll methods.
cellSet in interface Table<R,C,V>public abstract ImmutableMap<R,V> column(C columnKey)
Changes to the returned map will update the underlying table, and vice versa.
column in interface Table<R,C,V>columnKey - key of column to search for in the table
NullPointerException - if columnKey is nullpublic abstract 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>s in the returned map are
ImmutableMaps as well.
columnMap in interface Table<R,C,V>public abstract ImmutableMap<C,V> row(R rowKey)
Changes to the returned map will update the underlying table, and vice versa.
row in interface Table<R,C,V>rowKey - key of row to search for in the table
NullPointerException - if rowKey is nullpublic abstract ImmutableSet<R> rowKeySet()
Table
rowKeySet in interface Table<R,C,V>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>s in the returned map are
ImmutableMaps as well.
rowMap in interface Table<R,C,V>public final void clear()
clear in interface Table<R,C,V>UnsupportedOperationException - always
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 keys
null if
no mapping existed for the keys
UnsupportedOperationException - alwayspublic final void putAll(Table<? extends R,? extends C,? extends V> table)
putAll in interface Table<R,C,V>table - the table to add to this table
UnsupportedOperationException - always
public final V remove(Object rowKey,
Object columnKey)
remove in interface Table<R,C,V>rowKey - row key of mapping to be removedcolumnKey - column key of mapping to be removed
null if
no such value existed
UnsupportedOperationException - always
public boolean equals(@Nullable
Object obj)
TableTable.cellSet(), are equal.
equals in interface Table<R,C,V>equals in class Objectpublic int hashCode()
TableTable.cellSet().
hashCode in interface Table<R,C,V>hashCode in class Objectpublic String toString()
toString in class Object
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||