org.opensocial.models

Class AppData

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap

org.json.simple.JSONObject

org.opensocial.models.Model

org.opensocial.models.AppData

All Implemented Interfaces:

Serializable, Cloneable, Map, org.json.simple.JSONAware, org.json.simple.JSONStreamAware

public class AppData
extends Model

OpenSocial model class representing AppData, uninterpreted key/value pairs. For reference: http://www.opensocial.org/Technical-Resources/opensocial-spec-v09/REST-API.html#rfc.section.3.5

Author:

Jason Cooper

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

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

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AppData()

Method Summary

Methods

Modifier and Type	Method and Description
String	getDataForUser(String userId, String key) Returns the value of the specified AppData key for the specified user.
Set<String>	getFieldNamesForUser(String userId) Returns the complete set of AppData keys set for the specified user.

Methods inherited from class org.opensocial.models.Model

addTemplateParameter, addToListField, getField, getFieldAsList, getFieldAsMap, getFieldAsString, getFieldNames, getTemplateParameter, hasField, isFieldMultikeyed, isFieldMultivalued, setField

Methods inherited from class org.json.simple.JSONObject

escape, toJSONString, toJSONString, toString, toString, writeJSONString, writeJSONString

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Constructor Detail

AppData

public AppData()

Method Detail

getDataForUser

public String getDataForUser(String userId,
                    String key)

Returns the value of the specified AppData key for the specified user.

Parameters:

userId - OpenSocial ID of user whose AppData is requested

key - AppData key to fetch for the specified user

getFieldNamesForUser

public Set<String> getFieldNamesForUser(String userId)

Returns the complete set of AppData keys set for the specified user.

Parameters:

userId - OpenSocial ID of user whose AppData keys are to be returned