Interface MapFieldSchema

All Known Implementing Classes:

MapFieldSchemaFull, MapFieldSchemaLite

@CheckReturnValue
interface MapFieldSchema

Method Summary

Modifier and Type	Method	Description
Map<?,?>	forMapData(Object mapField)	Returns the map data for read.
MapEntryLite.Metadata<?,?>	forMapMetadata(Object mapDefaultEntry)	Returns the metadata from a default entry.
Map<?,?>	forMutableMapData(Object mapField)	Returns the map data for mutation.
int	getSerializedSize(int fieldNumber, Object mapField, Object mapDefaultEntry)	Compute the serialized size for the map with a given field number.
boolean	isImmutable(Object mapField)	Whether toImmutable() has been called on this map field.
Object	mergeFrom(Object destMapField, Object srcMapField)	Merges srcMapField into destMapField, and returns the merged instance.
Object	newMapField(Object mapDefaultEntry)	Returns a new instance of the map field given a map default entry.
Object	toImmutable(Object mapField)	Returns an immutable instance of the map field.

Method Details

forMutableMapData

Map<?,?> forMutableMapData(Object mapField)

Returns the map data for mutation.

forMapData

Map<?,?> forMapData(Object mapField)

Returns the map data for read.

isImmutable

boolean isImmutable(Object mapField)

Whether toImmutable() has been called on this map field.

toImmutable

Object toImmutable(Object mapField)

Returns an immutable instance of the map field. It may make the parameter immutable and return the parameter, or create an immutable copy. The status of the parameter after the call is undefined.

newMapField

Object newMapField(Object mapDefaultEntry)

Returns a new instance of the map field given a map default entry.

forMapMetadata

MapEntryLite.Metadata<?,?> forMapMetadata(Object mapDefaultEntry)

Returns the metadata from a default entry.

mergeFrom

@CanIgnoreReturnValue
Object mergeFrom(Object destMapField,
 Object srcMapField)

Merges srcMapField into destMapField, and returns the merged instance.

getSerializedSize

int getSerializedSize(int fieldNumber,
 Object mapField,
 Object mapDefaultEntry)

Compute the serialized size for the map with a given field number.