Class GenericData

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

All Implemented Interfaces:

Cloneable, Map<String,Object>

Direct Known Subclasses:

GenericJson, GenericUrl, GenericXml, HttpHeaders, JsonRpcRequest

public class GenericData
extends AbstractMap<String,Object>
implements Cloneable

Generic data that stores all unknown data key name/value pairs.

Subclasses can declare fields for known data keys using the Key annotation. Each field can be of any visibility (private, package private, protected, or public) and must not be static. null unknown data key names are not allowed, but null data values are allowed.

Iteration order of the data keys is based on the sorted (ascending) key names of the declared fields, followed by the iteration order of all of the unknown data key name/value pairs.

Implementation is not thread-safe. For a thread-safe choice instead use an implementation of ConcurrentMap.

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) final class	GenericData.EntryIterator	Iterator over the object data key/value map entries which iterates first over the fields and then over the unknown keys.
(package private) final class	GenericData.EntrySet	Set of object data key/value map entries.
static enum	GenericData.Flags	Flags that impact behavior of generic data.

Nested classes/interfaces inherited from class AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final ClassInfo	classInfo	Class information.
(package private) Map<String,Object>	unknownFields	Map of unknown fields.

Constructor Summary

Constructors

Constructor	Description
GenericData()	Constructs with case-insensitive keys.
GenericData(EnumSet<GenericData.Flags> flags)

Method Summary

Modifier and Type	Method	Description
GenericData	clone()	Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.
Set<Map.Entry<String,Object>>	entrySet()
boolean	equals(Object o)
final Object	get(Object name)
final ClassInfo	getClassInfo()	Returns the class information.
final Map<String,Object>	getUnknownKeys()	Returns the map of unknown data key name to value.
int	hashCode()
final Object	put(String fieldName, Object value)
final void	putAll(Map<? extends String, ?> map)
final Object	remove(Object name)
GenericData	set(String fieldName, Object value)	Sets the given field value (may be null) for the given field name.
final void	setUnknownKeys(Map<String,Object> unknownFields)	Sets the map of unknown data key name to value.
String	toString()

Methods inherited from class AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Details

unknownFields

Map<String,Object> unknownFields

Map of unknown fields.

classInfo

final ClassInfo classInfo

Class information.

Constructor Details

GenericData

public GenericData()

Constructs with case-insensitive keys.

GenericData

public GenericData(EnumSet<GenericData.Flags> flags)

Parameters:

flags - flags that impact behavior of generic data

Since:

1.10

Method Details

get

public final Object get(Object name)

Specified by:

get in interface Map<String,Object>

Overrides:

get in class AbstractMap<String,Object>

put

public final Object put(String fieldName,
 Object value)

Specified by:

put in interface Map<String,Object>

Overrides:

put in class AbstractMap<String,Object>

set

public GenericData set(String fieldName,
 Object value)

Sets the given field value (may be null) for the given field name. Any existing value for the field will be overwritten. It may be more slightly more efficient than put(String, Object) because it avoids accessing the field's original value.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

putAll

public final void putAll(Map<? extends String, ?> map)

Specified by:

putAll in interface Map<String,Object>

Overrides:

putAll in class AbstractMap<String,Object>

remove

public final Object remove(Object name)

Specified by:

remove in interface Map<String,Object>

Overrides:

remove in class AbstractMap<String,Object>

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

Specified by:

entrySet in class AbstractMap<String,Object>

clone

public GenericData clone()

Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.

Overrides:

clone in class AbstractMap<String,Object>

getUnknownKeys

public final Map<String,Object> getUnknownKeys()

Returns the map of unknown data key name to value.

Since:

1.5

setUnknownKeys

public final void setUnknownKeys(Map<String,Object> unknownFields)

Sets the map of unknown data key name to value.

Since:

1.5

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<String,Object>

Overrides:

equals in class AbstractMap<String,Object>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<String,Object>

Overrides:

hashCode in class AbstractMap<String,Object>

toString

public String toString()

Overrides:

toString in class AbstractMap<String,Object>

getClassInfo

public final ClassInfo getClassInfo()

Returns the class information.

Since:

1.10